FS/FS/Conf.pm

   1 package FS::Conf;
   2
   3 use vars qw($base_dir @config_items @base_items @card_types $DEBUG);
   4 use strict;
   5 use vars qw( $base_dir @config_items @base_items @card_types @invoice_terms
   6              $DEBUG
   7            );
   8 use Carp;
   9 use IO::File;
  10 use File::Basename;
  11 use MIME::Base64;
  12 use Email::Address;
  13 use FS::ConfItem;
  14 use FS::ConfDefaults;
  15 use FS::Conf_compat17;
  16 use FS::Locales;
  17 use FS::payby;
  18 use FS::conf;
  19 use FS::Record qw(qsearch qsearchs);
  20 use FS::UID qw(dbh datasrc use_confcompat);
  21 use FS::Misc::Invoicing qw( spool_formats );
  22
  23 $base_dir = '%%%FREESIDE_CONF%%%';
  24
  25 $DEBUG = 0;
  26
  27 =head1 NAME
  28
  29 FS::Conf - Freeside configuration values
  30
  31 =head1 SYNOPSIS
  32
  33   use FS::Conf;
  34
  35   $conf = new FS::Conf;
  36
  37   $value = $conf->config('key');
  38   @list  = $conf->config('key');
  39   $bool  = $conf->exists('key');
  40
  41   $conf->touch('key');
  42   $conf->set('key' => 'value');
  43   $conf->delete('key');
  44
  45   @config_items = $conf->config_items;
  46
  47 =head1 DESCRIPTION
  48
  49 Read and write Freeside configuration values.  Keys currently map to filenames,
  50 but this may change in the future.
  51
  52 =head1 METHODS
  53
  54 =over 4
  55
  56 =item new [ HASHREF ]
  57
  58 Create a new configuration object.
  59
  60 HASHREF may contain options to set the configuration context.  Currently
  61 accepts C<locale>, and C<localeonly> to disable fallback to the null locale.
  62
  63 =cut
  64
  65 sub new {
  66   my($proto) = shift;
  67   my $opts = shift || {};
  68   my($class) = ref($proto) || $proto;
  69   my $self = {
  70     'base_dir'    => $base_dir,
  71     'locale'      => $opts->{locale},
  72     'localeonly'  => $opts->{localeonly}, # for config-view.cgi ONLY
  73   };
  74   warn "FS::Conf created with no locale fallback.\n" if $self->{localeonly};
  75   bless ($self, $class);
  76 }
  77
  78 =item base_dir
  79
  80 Returns the base directory.  By default this is /usr/local/etc/freeside.
  81
  82 =cut
  83
  84 sub base_dir {
  85   my($self) = @_;
  86   my $base_dir = $self->{base_dir};
  87   -e $base_dir or die "FATAL: $base_dir doesn't exist!";
  88   -d $base_dir or die "FATAL: $base_dir isn't a directory!";
  89   -r $base_dir or die "FATAL: Can't read $base_dir!";
  90   -x $base_dir or die "FATAL: $base_dir not searchable (executable)!";
  91   $base_dir =~ /^(.*)$/;
  92   $1;
  93 }
  94
  95 =item conf KEY [ AGENTNUM [ NODEFAULT ] ]
  96
  97 Returns the L<FS::conf> record for the key and agent.
  98
  99 =cut
 100
 101 sub conf {
 102   my $self = shift;
 103   $self->_config(@_);
 104 }
 105
 106 =item config KEY [ AGENTNUM [ NODEFAULT ] ]
 107
 108 Returns the configuration value or values (depending on context) for key.
 109 The optional agent number selects an agent specific value instead of the
 110 global default if one is present.  If NODEFAULT is true only the agent
 111 specific value(s) is returned.
 112
 113 =cut
 114
 115 sub _usecompat {
 116   my ($self, $method) = (shift, shift);
 117   carp "NO CONFIGURATION RECORDS FOUND -- USING COMPATIBILITY MODE"
 118     if use_confcompat;
 119   my $compat = new FS::Conf_compat17 ("$base_dir/conf." . datasrc);
 120   $compat->$method(@_);
 121 }
 122
 123 sub _config {
 124   my($self,$name,$agentnum,$agentonly)=@_;
 125   my $hashref = { 'name' => $name };
 126   local $FS::Record::conf = undef;  # XXX evil hack prevents recursion
 127   my $cv;
 128   my @a = (
 129     ($agentnum || ()),
 130     ($agentonly && $agentnum ? () : '')
 131   );
 132   my @l = (
 133     ($self->{locale} || ()),
 134     ($self->{localeonly} && $self->{locale} ? () : '')
 135   );
 136   # try with the agentnum first, then fall back to no agentnum if allowed
 137   foreach my $a (@a) {
 138     $hashref->{agentnum} = $a;
 139     foreach my $l (@l) {
 140       $hashref->{locale} = $l;
 141       $cv = FS::Record::qsearchs('conf', $hashref);
 142       return $cv if $cv;
 143     }
 144   }
 145   return undef;
 146 }
 147
 148 sub config {
 149   my $self = shift;
 150   return $self->_usecompat('config', @_) if use_confcompat;
 151
 152   carp "FS::Conf->config(". join(', ', @_). ") called"
 153     if $DEBUG > 1;
 154
 155   my $cv = $self->_config(@_) or return;
 156
 157   if ( wantarray ) {
 158     my $v = $cv->value;
 159     chomp $v;
 160     (split "\n", $v, -1);
 161   } else {
 162     (split("\n", $cv->value))[0];
 163   }
 164 }
 165
 166 =item config_binary KEY [ AGENTNUM [ NODEFAULT ] ]
 167
 168 Returns the exact scalar value for key.
 169
 170 =cut
 171
 172 sub config_binary {
 173   my $self = shift;
 174   return $self->_usecompat('config_binary', @_) if use_confcompat;
 175
 176   my $cv = $self->_config(@_) or return;
 177   length($cv->value) ? decode_base64($cv->value) : '';
 178 }
 179
 180 =item exists KEY [ AGENTNUM [ NODEFAULT ] ]
 181
 182 Returns true if the specified key exists, even if the corresponding value
 183 is undefined.
 184
 185 =cut
 186
 187 sub exists {
 188   my $self = shift;
 189   return $self->_usecompat('exists', @_) if use_confcompat;
 190
 191   #my($name, $agentnum)=@_;
 192
 193   carp "FS::Conf->exists(". join(', ', @_). ") called"
 194     if $DEBUG > 1;
 195
 196   defined($self->_config(@_));
 197 }
 198
 199 #maybe this should just be the new exists instead of getting a method of its
 200 #own, but i wanted to avoid possible fallout
 201
 202 sub config_bool {
 203   my $self = shift;
 204   return $self->_usecompat('exists', @_) if use_confcompat;
 205
 206   my($name,$agentnum,$agentonly) = @_;
 207
 208   carp "FS::Conf->config_bool(". join(', ', @_). ") called"
 209     if $DEBUG > 1;
 210
 211   #defined($self->_config(@_));
 212
 213   #false laziness w/_config
 214   my $hashref = { 'name' => $name };
 215   local $FS::Record::conf = undef;  # XXX evil hack prevents recursion
 216   my $cv;
 217   my @a = (
 218     ($agentnum || ()),
 219     ($agentonly && $agentnum ? () : '')
 220   );
 221   my @l = (
 222     ($self->{locale} || ()),
 223     ($self->{localeonly} && $self->{locale} ? () : '')
 224   );
 225   # try with the agentnum first, then fall back to no agentnum if allowed
 226   foreach my $a (@a) {
 227     $hashref->{agentnum} = $a;
 228     foreach my $l (@l) {
 229       $hashref->{locale} = $l;
 230       $cv = FS::Record::qsearchs('conf', $hashref);
 231       if ( $cv ) {
 232         if ( $cv->value eq '0'
 233                && ($hashref->{agentnum} || $hashref->{locale} )
 234            )
 235         {
 236           return 0; #an explicit false override, don't continue looking
 237         } else {
 238           return 1;
 239         }
 240       }
 241     }
 242   }
 243   return 0;
 244
 245 }
 246
 247 =item config_orbase KEY SUFFIX
 248
 249 Returns the configuration value or values (depending on context) for
 250 KEY_SUFFIX, if it exists, otherwise for KEY
 251
 252 =cut
 253
 254 # outmoded as soon as we shift to agentnum based config values
 255 # well, mostly.  still useful for e.g. late notices, etc. in that we want
 256 # these to fall back to standard values
 257 sub config_orbase {
 258   my $self = shift;
 259   return $self->_usecompat('config_orbase', @_) if use_confcompat;
 260
 261   my( $name, $suffix ) = @_;
 262   if ( $self->exists("${name}_$suffix") ) {
 263     $self->config("${name}_$suffix");
 264   } else {
 265     $self->config($name);
 266   }
 267 }
 268
 269 =item key_orbase KEY SUFFIX
 270
 271 If the config value KEY_SUFFIX exists, returns KEY_SUFFIX, otherwise returns
 272 KEY.  Useful for determining which exact configuration option is returned by
 273 config_orbase.
 274
 275 =cut
 276
 277 sub key_orbase {
 278   my $self = shift;
 279   #no compat for this...return $self->_usecompat('config_orbase', @_) if use_confcompat;
 280
 281   my( $name, $suffix ) = @_;
 282   if ( $self->exists("${name}_$suffix") ) {
 283     "${name}_$suffix";
 284   } else {
 285     $name;
 286   }
 287 }
 288
 289 =item invoice_templatenames
 290
 291 Returns all possible invoice template names.
 292
 293 =cut
 294
 295 sub invoice_templatenames {
 296   my( $self ) = @_;
 297
 298   my %templatenames = ();
 299   foreach my $item ( $self->config_items ) {
 300     foreach my $base ( @base_items ) {
 301       my( $main, $ext) = split(/\./, $base);
 302       $ext = ".$ext" if $ext;
 303       if ( $item->key =~ /^${main}_(.+)$ext$/ ) {
 304       $templatenames{$1}++;
 305       }
 306     }
 307   }
 308
 309   map { $_ } #handle scalar context
 310   sort keys %templatenames;
 311
 312 }
 313
 314 =item touch KEY [ AGENT ];
 315
 316 Creates the specified configuration key if it does not exist.
 317
 318 =cut
 319
 320 sub touch {
 321   my $self = shift;
 322   return $self->_usecompat('touch', @_) if use_confcompat;
 323
 324   my($name, $agentnum) = @_;
 325   #unless ( $self->exists($name, $agentnum) ) {
 326   unless ( $self->config_bool($name, $agentnum) ) {
 327     if ( $agentnum && $self->exists($name) && $self->config($name,$agentnum) eq '0' ) {
 328       $self->delete($name, $agentnum);
 329     } else {
 330       $self->set($name, '', $agentnum);
 331     }
 332   }
 333 }
 334
 335 =item set KEY VALUE [ AGENTNUM ];
 336
 337 Sets the specified configuration key to the given value.
 338
 339 =cut
 340
 341 sub set {
 342   my $self = shift;
 343   return $self->_usecompat('set', @_) if use_confcompat;
 344
 345   my($name, $value, $agentnum) = @_;
 346   $value =~ /^(.*)$/s;
 347   $value = $1;
 348
 349   warn "[FS::Conf] SET $name\n" if $DEBUG;
 350
 351   my $hashref = {
 352     name => $name,
 353     agentnum => $agentnum,
 354     locale => $self->{locale}
 355   };
 356
 357   my $old = FS::Record::qsearchs('conf', $hashref);
 358   my $new = new FS::conf { $old ? $old->hash : %$hashref };
 359   $new->value($value);
 360
 361   my $error;
 362   if ($old) {
 363     $error = $new->replace($old);
 364   } else {
 365     $error = $new->insert;
 366   }
 367
 368   die "error setting configuration value: $error \n"
 369     if $error;
 370
 371 }
 372
 373 =item set_binary KEY VALUE [ AGENTNUM ]
 374
 375 Sets the specified configuration key to an exact scalar value which
 376 can be retrieved with config_binary.
 377
 378 =cut
 379
 380 sub set_binary {
 381   my $self  = shift;
 382   return if use_confcompat;
 383
 384   my($name, $value, $agentnum)=@_;
 385   $self->set($name, encode_base64($value), $agentnum);
 386 }
 387
 388 =item delete KEY [ AGENTNUM ];
 389
 390 Deletes the specified configuration key.
 391
 392 =cut
 393
 394 sub delete {
 395   my $self = shift;
 396   return $self->_usecompat('delete', @_) if use_confcompat;
 397
 398   my($name, $agentnum) = @_;
 399   if ( my $cv = FS::Record::qsearchs('conf', {name => $name, agentnum => $agentnum, locale => $self->{locale}}) ) {
 400     warn "[FS::Conf] DELETE $name\n" if $DEBUG;
 401
 402     my $oldAutoCommit = $FS::UID::AutoCommit;
 403     local $FS::UID::AutoCommit = 0;
 404     my $dbh = dbh;
 405
 406     my $error = $cv->delete;
 407
 408     if ( $error ) {
 409       $dbh->rollback if $oldAutoCommit;
 410       die "error setting configuration value: $error \n"
 411     }
 412
 413     $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 414
 415   }
 416 }
 417
 418 #maybe this should just be the new delete instead of getting a method of its
 419 #own, but i wanted to avoid possible fallout
 420
 421 sub delete_bool {
 422   my $self = shift;
 423   return $self->_usecompat('delete', @_) if use_confcompat;
 424
 425   my($name, $agentnum) = @_;
 426
 427   warn "[FS::Conf] DELETE $name\n" if $DEBUG;
 428
 429   my $cv = FS::Record::qsearchs('conf', { name     => $name,
 430                                           agentnum => $agentnum,
 431                                           locale   => $self->{locale},
 432                                         });
 433
 434   if ( $cv ) {
 435     my $error = $cv->delete;
 436     die $error if $error;
 437   } elsif ( $agentnum ) {
 438     $self->set($name, '0', $agentnum);
 439   }
 440
 441 }
 442
 443 =item import_config_item CONFITEM DIR
 444
 445   Imports the item specified by the CONFITEM (see L<FS::ConfItem>) into
 446 the database as a conf record (see L<FS::conf>).  Imports from the file
 447 in the directory DIR.
 448
 449 =cut
 450
 451 sub import_config_item {
 452   my ($self,$item,$dir) = @_;
 453   my $key = $item->key;
 454   if ( -e "$dir/$key" && ! use_confcompat ) {
 455     warn "Inserting $key\n" if $DEBUG;
 456     local $/;
 457     my $value = readline(new IO::File "$dir/$key");
 458     if ($item->type =~ /^(binary|image)$/ ) {
 459       $self->set_binary($key, $value);
 460     }else{
 461       $self->set($key, $value);
 462     }
 463   }else {
 464     warn "Not inserting $key\n" if $DEBUG;
 465   }
 466 }
 467
 468 =item verify_config_item CONFITEM DIR
 469
 470   Compares the item specified by the CONFITEM (see L<FS::ConfItem>) in
 471 the database to the legacy file value in DIR.
 472
 473 =cut
 474
 475 sub verify_config_item {
 476   return '' if use_confcompat;
 477   my ($self,$item,$dir) = @_;
 478   my $key = $item->key;
 479   my $type = $item->type;
 480
 481   my $compat = new FS::Conf_compat17 $dir;
 482   my $error = '';
 483
 484   $error .= "$key fails existential comparison; "
 485     if $self->exists($key) xor $compat->exists($key);
 486
 487   if ( $type !~ /^(binary|image)$/ ) {
 488
 489     {
 490       no warnings;
 491       $error .= "$key fails scalar comparison; "
 492         unless scalar($self->config($key)) eq scalar($compat->config($key));
 493     }
 494
 495     my (@new) = $self->config($key);
 496     my (@old) = $compat->config($key);
 497     unless ( scalar(@new) == scalar(@old)) {
 498       $error .= "$key fails list comparison; ";
 499     }else{
 500       my $r=1;
 501       foreach (@old) { $r=0 if ($_ cmp shift(@new)); }
 502       $error .= "$key fails list comparison; "
 503         unless $r;
 504     }
 505
 506   } else {
 507
 508     no warnings 'uninitialized';
 509     $error .= "$key fails binary comparison; "
 510       unless scalar($self->config_binary($key)) eq scalar($compat->config_binary($key));
 511
 512   }
 513
 514 #remove deprecated config on our own terms, not freeside-upgrade's
 515 #  if ($error =~ /existential comparison/ && $item->section eq 'deprecated') {
 516 #    my $proto;
 517 #    for ( @config_items ) { $proto = $_; last if $proto->key eq $key;  }
 518 #    unless ($proto->key eq $key) {
 519 #      warn "removed config item $error\n" if $DEBUG;
 520 #      $error = '';
 521 #    }
 522 #  }
 523
 524   $error;
 525 }
 526
 527 #item _orbase_items OPTIONS
 528 #
 529 #Returns all of the possible extensible config items as FS::ConfItem objects.
 530 #See #L<FS::ConfItem>.  OPTIONS consists of name value pairs.  Possible
 531 #options include
 532 #
 533 # dir - the directory to search for configuration option files instead
 534 #       of using the conf records in the database
 535 #
 536 #cut
 537
 538 #quelle kludge
 539 sub _orbase_items {
 540   my ($self, %opt) = @_;
 541
 542   my $listmaker = sub { my $v = shift;
 543                         $v =~ s/_/!_/g;
 544                         if ( $v =~ /\.(png|eps)$/ ) {
 545                           $v =~ s/\./!_%./;
 546                         }else{
 547                           $v .= '!_%';
 548                         }
 549                         map { $_->name }
 550                           FS::Record::qsearch( 'conf',
 551                                                {},
 552                                                '',
 553                                                "WHERE name LIKE '$v' ESCAPE '!'"
 554                                              );
 555                       };
 556
 557   if (exists($opt{dir}) && $opt{dir}) {
 558     $listmaker = sub { my $v = shift;
 559                        if ( $v =~ /\.(png|eps)$/ ) {
 560                          $v =~ s/\./_*./;
 561                        }else{
 562                          $v .= '_*';
 563                        }
 564                        map { basename $_ } glob($opt{dir}. "/$v" );
 565                      };
 566   }
 567
 568   ( map {
 569           my $proto;
 570           my $base = $_;
 571           for ( @config_items ) { $proto = $_; last if $proto->key eq $base;  }
 572           die "don't know about $base items" unless $proto->key eq $base;
 573
 574           map { new FS::ConfItem {
 575                   'key'         => $_,
 576                   'base_key'    => $proto->key,
 577                   'section'     => $proto->section,
 578                   'description' => 'Alternate ' . $proto->description . '  See the <a href="http://www.freeside.biz/mediawiki/index.php/Freeside:3:Documentation:Administration#Invoice_templates">billing documentation</a> for details.',
 579                   'type'        => $proto->type,
 580                 };
 581               } &$listmaker($base);
 582         } @base_items,
 583   );
 584 }
 585
 586 =item config_items
 587
 588 Returns all of the possible global/default configuration items as
 589 FS::ConfItem objects.  See L<FS::ConfItem>.
 590
 591 =cut
 592
 593 sub config_items {
 594   my $self = shift;
 595   return $self->_usecompat('config_items', @_) if use_confcompat;
 596
 597   ( @config_items, $self->_orbase_items(@_) );
 598 }
 599
 600 =item invoice_from_full [ AGENTNUM ]
 601
 602 Returns values of invoice_from and invoice_from_name, appropriately combined
 603 based on their current values.
 604
 605 =cut
 606
 607 sub invoice_from_full {
 608   my ($self, $agentnum) = @_;
 609
 610   my $name =  $self->config('invoice_from_name', $agentnum)
 611            || $self->config('company_name', $agentnum);
 612
 613   Email::Address->new( $name => $self->config('invoice_from', $agentnum ) )
 614     ->format;
 615 }
 616
 617 =back
 618
 619 =head1 SUBROUTINES
 620
 621 =over 4
 622
 623 =item init-config DIR
 624
 625 Imports the configuration items from DIR (1.7 compatible)
 626 to conf records in the database.
 627
 628 =cut
 629
 630 sub init_config {
 631   my $dir = shift;
 632
 633   {
 634     local $FS::UID::use_confcompat = 0;
 635     my $conf = new FS::Conf;
 636     foreach my $item ( $conf->config_items(dir => $dir) ) {
 637       $conf->import_config_item($item, $dir);
 638       my $error = $conf->verify_config_item($item, $dir);
 639       return $error if $error;
 640     }
 641
 642     my $compat = new FS::Conf_compat17 $dir;
 643     foreach my $item ( $compat->config_items ) {
 644       my $error = $conf->verify_config_item($item, $dir);
 645       return $error if $error;
 646     }
 647   }
 648
 649   $FS::UID::use_confcompat = 0;
 650   '';  #success
 651 }
 652
 653 =back
 654
 655 =head1 BUGS
 656
 657 If this was more than just crud that will never be useful outside Freeside I'd
 658 worry that config_items is freeside-specific and icky.
 659
 660 =head1 SEE ALSO
 661
 662 "Configuration" in the web interface (config/config.cgi).
 663
 664 =cut
 665
 666 #Business::CreditCard
 667 @card_types = (
 668   "VISA card",
 669   "MasterCard",
 670   "Discover card",
 671   "American Express card",
 672   "Diner's Club/Carte Blanche",
 673   "enRoute",
 674   "JCB",
 675   "BankCard",
 676   "Switch",
 677   "Solo",
 678 );
 679
 680 @base_items = qw(
 681 invoice_template
 682 invoice_latex
 683 invoice_latexreturnaddress
 684 invoice_latexfooter
 685 invoice_latexsmallfooter
 686 invoice_latexnotes
 687 invoice_latexcoupon
 688 invoice_latexwatermark
 689 invoice_html
 690 invoice_htmlreturnaddress
 691 invoice_htmlfooter
 692 invoice_htmlnotes
 693 invoice_htmlwatermark
 694 logo.png
 695 logo.eps
 696 );
 697
 698 @invoice_terms = (
 699   '',
 700   'Payable upon receipt',
 701   'Net 0', 'Net 3', 'Net 5', 'Net 7', 'Net 9', 'Net 10', 'Net 14',
 702   'Net 15', 'Net 18', 'Net 20', 'Net 21', 'Net 25', 'End of Month', 'Net 30',
 703   'Net 45', 'Net 60', 'Net 90'
 704 );
 705
 706 my %msg_template_options = (
 707   'type'        => 'select-sub',
 708   'options_sub' => sub {
 709     my @templates = qsearch({
 710         'table' => 'msg_template',
 711         'hashref' => { 'disabled' => '' },
 712         'extra_sql' => ' AND '.
 713           $FS::CurrentUser::CurrentUser->agentnums_sql(null => 1),
 714         });
 715     map { $_->msgnum, $_->msgname } @templates;
 716   },
 717   'option_sub'  => sub {
 718                          my $msg_template = FS::msg_template->by_key(shift);
 719                          $msg_template ? $msg_template->msgname : ''
 720                        },
 721   'per_agent' => 1,
 722 );
 723
 724 my %payment_gateway_options = (
 725   'type'        => 'select-sub',
 726   'options_sub' => sub {
 727     my @gateways = qsearch({
 728         'table' => 'payment_gateway',
 729         'hashref' => { 'disabled' => '' },
 730       });
 731     map { $_->gatewaynum, $_->label } @gateways;
 732   },
 733   'option_sub'  => sub {
 734     my $gateway = FS::payment_gateway->by_key(shift);
 735     $gateway ? $gateway->label : ''
 736   },
 737 );
 738
 739 my %batch_gateway_options = (
 740   %payment_gateway_options,
 741   'options_sub' => sub {
 742     my @gateways = qsearch('payment_gateway',
 743       {
 744         'disabled'          => '',
 745         'gateway_namespace' => 'Business::BatchPayment',
 746       }
 747     );
 748     map { $_->gatewaynum, $_->label } @gateways;
 749   },
 750   'per_agent' => 1,
 751 );
 752
 753 my %invoice_mode_options = (
 754   'type'        => 'select-sub',
 755   'options_sub' => sub {
 756     my @modes = qsearch({
 757         'table' => 'invoice_mode',
 758         'extra_sql' => ' WHERE '.
 759           $FS::CurrentUser::CurrentUser->agentnums_sql(null => 1),
 760         });
 761     map { $_->modenum, $_->modename } @modes;
 762   },
 763   'option_sub'  => sub {
 764                          my $mode = FS::invoice_mode->by_key(shift);
 765                          $mode ? $mode->modename : '',
 766                        },
 767   'per_agent' => 1,
 768 );
 769
 770 my @cdr_formats = (
 771   '' => '',
 772   'default' => 'Default',
 773   'source_default' => 'Default with source',
 774   'accountcode_default' => 'Default plus accountcode',
 775   'description_default' => 'Default with description field as destination',
 776   'basic' => 'Basic',
 777   'simple' => 'Simple',
 778   'simple2' => 'Simple with source',
 779   'accountcode_simple' => 'Simple with accountcode',
 780 );
 781
 782 # takes the reason class (C, R, S) as an argument
 783 sub reason_type_options {
 784   my $reason_class = shift;
 785
 786   'type'        => 'select-sub',
 787   'options_sub' => sub {
 788     map { $_->typenum => $_->type }
 789       qsearch('reason_type', { class => $reason_class });
 790   },
 791   'option_sub'  => sub {
 792     my $type = FS::reason_type->by_key(shift);
 793     $type ? $type->type : '';
 794   }
 795 }
 796
 797 my $validate_email = sub { $_[0] =~
 798                              /^[^@]+\@[[:alnum:]-]+(\.[[:alnum:]-]+)+$/
 799                              ? '' : 'Invalid email address';
 800                          };
 801
 802 #Billing (81 items)
 803 #Invoicing (50 items)
 804 #UI (69 items)
 805 #Self-service (29 items)
 806 #...
 807 #Unclassified (77 items)
 808
 809 @config_items = map { new FS::ConfItem $_ } (
 810
 811   {
 812     'key'         => 'address',
 813     'section'     => 'deprecated',
 814     'description' => 'This configuration option is no longer used.  See <a href="#invoice_template">invoice_template</a> instead.',
 815     'type'        => 'text',
 816   },
 817
 818   {
 819     'key'         => 'event_log_level',
 820     'section'     => 'notification',
 821     'description' => 'Store events in the internal log if they are at least this severe.  "info" is the default, "debug" is very detailed and noisy.',
 822     'type'        => 'select',
 823     'select_enum' => [ '', 'debug', 'info', 'notice', 'warning', 'error', ],
 824     # don't bother with higher levels
 825   },
 826
 827   {
 828     'key'         => 'log_sent_mail',
 829     'section'     => 'notification',
 830     'description' => 'Enable logging of template-generated email.',
 831     'type'        => 'checkbox',
 832   },
 833
 834   {
 835     'key'         => 'alert_expiration',
 836     'section'     => 'deprecated',
 837     'description' => 'Enable alerts about credit card expiration.  This is obsolete and no longer works.',
 838     'type'        => 'checkbox',
 839     'per_agent'   => 1,
 840   },
 841
 842   {
 843     'key'         => 'alerter_template',
 844     'section'     => 'deprecated',
 845     'description' => 'Template file for billing method expiration alerts (i.e. expiring credit cards).',
 846     'type'        => 'textarea',
 847     'per_agent'   => 1,
 848   },
 849
 850   {
 851     'key'         => 'alerter_msgnum',
 852     'section'     => 'deprecated',
 853     'description' => 'Template to use for credit card expiration alerts.',
 854     %msg_template_options,
 855   },
 856
 857   {
 858     'key'         => 'part_pkg-lineage',
 859     'section'     => '',
 860     'description' => 'When editing a package definition, if setup or recur fees are changed, create a new package rather than changing the existing package.',
 861     'type'        => 'checkbox',
 862   },
 863
 864   {
 865     'key'         => 'apacheip',
 866     #not actually deprecated yet
 867     #'section'     => 'deprecated',
 868     #'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',
 869     'section'     => '',
 870     'description' => 'IP address to assign to new virtual hosts',
 871     'type'        => 'text',
 872   },
 873
 874   {
 875     'key'         => 'credits-auto-apply-disable',
 876     'section'     => 'billing',
 877     'description' => 'Disable the "Auto-Apply to invoices" UI option for new credits',
 878     'type'        => 'checkbox',
 879   },
 880
 881   {
 882     'key'         => 'credit-card-surcharge-percentage',
 883     'section'     => 'billing',
 884     'description' => 'Add a credit card surcharge to invoices, as a % of the invoice total.  WARNING: Although recently permitted to US merchants in general, specific consumer protection laws may prohibit or restrict this practice in California, Colorado, Connecticut, Florda, Kansas, Maine, Massachusetts, New York, Oklahome, and Texas.  Surcharging is also generally prohibited in most countries outside the US, AU and UK.  When allowed, typically not permitted to be above 4%.',
 885     'type'        => 'text',
 886     'per_agent'   => 1,
 887   },
 888
 889   {
 890     'key'         => 'discount-show-always',
 891     'section'     => 'billing',
 892     'description' => 'Generate a line item on an invoice even when a package is discounted 100%',
 893     'type'        => 'checkbox',
 894   },
 895
 896   {
 897     'key'         => 'discount-show_available',
 898     'section'     => 'billing',
 899     'description' => 'Show available prepayment discounts on invoices.',
 900     'type'        => 'checkbox',
 901   },
 902
 903   {
 904     'key'         => 'invoice-barcode',
 905     'section'     => 'billing',
 906     'description' => 'Display a barcode on HTML and PDF invoices',
 907     'type'        => 'checkbox',
 908   },
 909
 910   {
 911     'key'         => 'cust_main-select-billday',
 912     'section'     => 'billing',
 913     'description' => 'When used with a specific billing event, allows the selection of the day of month on which to charge credit card / bank account automatically, on a per-customer basis',
 914     'type'        => 'checkbox',
 915   },
 916
 917   {
 918     'key'         => 'cust_main-select-prorate_day',
 919     'section'     => 'billing',
 920     'description' => 'When used with prorate or anniversary packages, allows the selection of the prorate day of month, on a per-customer basis',
 921     'type'        => 'checkbox',
 922   },
 923
 924   {
 925     'key'         => 'anniversary-rollback',
 926     'section'     => 'billing',
 927     'description' => 'When billing an anniversary package ordered after the 28th, roll the anniversary date back to the 28th instead of forward into the following month.',
 928     'type'        => 'checkbox',
 929   },
 930
 931   {
 932     'key'         => 'encryption',
 933     'section'     => 'billing',
 934     'description' => 'Enable encryption of credit cards and echeck numbers',
 935     'type'        => 'checkbox',
 936   },
 937
 938   {
 939     'key'         => 'encryptionmodule',
 940     'section'     => 'billing',
 941     'description' => 'Use which module for encryption?',
 942     'type'        => 'select',
 943     'select_enum' => [ '', 'Crypt::OpenSSL::RSA', ],
 944   },
 945
 946   {
 947     'key'         => 'encryptionpublickey',
 948     'section'     => 'billing',
 949     'description' => 'Encryption public key',
 950     'type'        => 'textarea',
 951   },
 952
 953   {
 954     'key'         => 'encryptionprivatekey',
 955     'section'     => 'billing',
 956     'description' => 'Encryption private key',
 957     'type'        => 'textarea',
 958   },
 959
 960   {
 961     'key'         => 'billco-url',
 962     'section'     => 'billing',
 963     'description' => 'The url to use for performing uploads to the invoice mailing service.',
 964     'type'        => 'text',
 965     'per_agent'   => 1,
 966   },
 967
 968   {
 969     'key'         => 'billco-username',
 970     'section'     => 'billing',
 971     'description' => 'The login name to use for uploads to the invoice mailing service.',
 972     'type'        => 'text',
 973     'per_agent'   => 1,
 974     'agentonly'   => 1,
 975   },
 976
 977   {
 978     'key'         => 'billco-password',
 979     'section'     => 'billing',
 980     'description' => 'The password to use for uploads to the invoice mailing service.',
 981     'type'        => 'text',
 982     'per_agent'   => 1,
 983     'agentonly'   => 1,
 984   },
 985
 986   {
 987     'key'         => 'billco-clicode',
 988     'section'     => 'billing',
 989     'description' => 'The clicode to use for uploads to the invoice mailing service.',
 990     'type'        => 'text',
 991     'per_agent'   => 1,
 992   },
 993
 994   {
 995     'key'         => 'billco-account_num',
 996     'section'     => 'billing',
 997     'description' => 'The data to place in the "Transaction Account No" / "TRACCTNUM" field.',
 998     'type'        => 'select',
 999     'select_hash' => [
1000                        'invnum-date' => 'Invoice number - Date (default)',
1001                        'display_custnum'  => 'Customer number',
1002                      ],
1003     'per_agent'   => 1,
1004   },
1005
1006   {
1007     'key'         => 'next-bill-ignore-time',
1008     'section'     => 'billing',
1009     'description' => 'Ignore the time portion of next bill dates when billing, matching anything from 00:00:00 to 23:59:59 on the billing day.',
1010     'type'        => 'checkbox',
1011   },
1012
1013   {
1014     'key'         => 'business-onlinepayment',
1015     'section'     => 'billing',
1016     '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.  For more detailed information and examples see the <a href="http://www.freeside.biz/mediawiki/index.php/Freeside:3:Documentation:Administration:Real-time_Processing">real-time credit card processing documentation</a>.',
1017     'type'        => 'textarea',
1018   },
1019
1020   {
1021     'key'         => 'business-onlinepayment-ach',
1022     'section'     => 'billing',
1023     '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.',
1024     'type'        => 'textarea',
1025   },
1026
1027   {
1028     'key'         => 'business-onlinepayment-namespace',
1029     'section'     => 'billing',
1030     'description' => 'Specifies which perl module namespace (which group of collection routines) is used by default.',
1031     'type'        => 'select',
1032     'select_hash' => [
1033                        'Business::OnlinePayment' => 'Direct API (Business::OnlinePayment)',
1034                        'Business::OnlineThirdPartyPayment' => 'Web API (Business::ThirdPartyPayment)',
1035                      ],
1036   },
1037
1038   {
1039     'key'         => 'business-onlinepayment-description',
1040     'section'     => 'billing',
1041     '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)',
1042     'type'        => 'text',
1043   },
1044
1045   {
1046     'key'         => 'business-onlinepayment-email-override',
1047     'section'     => 'billing',
1048     'description' => 'Email address used instead of customer email address when submitting a BOP transaction.',
1049     'type'        => 'text',
1050   },
1051
1052   {
1053     'key'         => 'business-onlinepayment-email_customer',
1054     'section'     => 'billing',
1055     'description' => 'Controls the "email_customer" flag used by some Business::OnlinePayment processors to enable customer receipts.',
1056     'type'        => 'checkbox',
1057   },
1058
1059   {
1060     'key'         => 'business-onlinepayment-test_transaction',
1061     'section'     => 'billing',
1062     '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.',
1063     'type'        => 'checkbox',
1064   },
1065
1066   {
1067     'key'         => 'business-onlinepayment-currency',
1068     'section'     => 'billing',
1069     'description' => 'Currency parameter for Business::OnlinePayment transactions.',
1070     'type'        => 'select',
1071     'select_enum' => [ '', qw( USD AUD CAD DKK EUR GBP ILS JPY NZD ) ],
1072   },
1073
1074   {
1075     'key'         => 'business-onlinepayment-verification',
1076     'section'     => 'billing',
1077     'description' => 'Run a $1 authorization (followed by a void) to verify new credit card information.',
1078     'type'        => 'checkbox',
1079   },
1080
1081   {
1082     'key'         => 'currency',
1083     'section'     => 'billing',
1084     'description' => 'Currency',
1085     'type'        => 'select',
1086     'select_enum' => [ '', qw( USD AUD CAD DKK EUR GBP ILS JPY NZD XAF ) ],
1087   },
1088
1089   {
1090     'key'         => 'business-batchpayment-test_transaction',
1091     'section'     => 'billing',
1092     'description' => 'Turns on the Business::BatchPayment test_mode flag.  Note that not all gateway modules support this flag; if yours does not, using the batch gateway will fail.',
1093     'type'        => 'checkbox',
1094   },
1095
1096   {
1097     'key'         => 'countrydefault',
1098     'section'     => 'UI',
1099     'description' => 'Default two-letter country code (if not supplied, the default is `US\')',
1100     'type'        => 'text',
1101   },
1102
1103   {
1104     'key'         => 'date_format',
1105     'section'     => 'UI',
1106     'description' => 'Format for displaying dates',
1107     'type'        => 'select',
1108     'select_hash' => [
1109                        '%m/%d/%Y' => 'MM/DD/YYYY',
1110                        '%d/%m/%Y' => 'DD/MM/YYYY',
1111                        '%Y/%m/%d' => 'YYYY/MM/DD',
1112                        '%e %b %Y' => 'DD Mon YYYY',
1113                      ],
1114     'per_locale'  => 1,
1115   },
1116
1117   {
1118     'key'         => 'date_format_long',
1119     'section'     => 'UI',
1120     'description' => 'Verbose format for displaying dates',
1121     'type'        => 'select',
1122     'select_hash' => [
1123                        '%b %o, %Y' => 'Mon DDth, YYYY',
1124                        '%e %b %Y'  => 'DD Mon YYYY',
1125                        '%m/%d/%Y'  => 'MM/DD/YYYY',
1126                        '%d/%m/%Y'  => 'DD/MM/YYYY',
1127                        '%Y/%m/%d'  => 'YYYY/MM/DD',
1128                      ],
1129     'per_locale'  => 1,
1130   },
1131
1132   {
1133     'key'         => 'deletecustomers',
1134     'section'     => 'deprecated',
1135     '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.',
1136     'type'        => 'checkbox',
1137   },
1138
1139   {
1140     'key'         => 'deleteinvoices',
1141     'section'     => 'UI',
1142     'description' => 'Enable invoices deletions.  Be very careful!  Deleting an invoice will remove all traces that the invoice ever existed!  Normally, you would void or apply a credit against the invoice instead.',
1143     'type'        => 'checkbox',
1144   },
1145
1146   {
1147     'key'         => 'deletepayments',
1148     'section'     => 'deprecated',
1149     '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.',
1150     'type'        => [qw( checkbox text )],
1151   },
1152
1153   {
1154     'key'         => 'deletecredits',
1155     #not actually deprecated yet
1156     #'section'     => 'deprecated',
1157     #'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.',
1158     'section'     => '',
1159     'description' => 'One or more comma-separated email addresses to be notified when a credit is deleted.',
1160     'type'        => [qw( checkbox text )],
1161   },
1162
1163   {
1164     'key'         => 'deleterefunds',
1165     'section'     => 'billing',
1166     'description' => 'Enable deletion of unclosed refunds.  Be very careful!  Only delete refunds that were data-entry errors, not adjustments.',
1167     'type'        => 'checkbox',
1168   },
1169
1170   {
1171     'key'         => 'unapplypayments',
1172     'section'     => 'deprecated',
1173     'description' => '<B>DEPRECATED</B>, now controlled by ACLs.  Used to enable "unapplication" of unclosed payments.',
1174     'type'        => 'checkbox',
1175   },
1176
1177   {
1178     'key'         => 'unapplycredits',
1179     'section'     => 'deprecated',
1180     'description' => '<B>DEPRECATED</B>, now controlled by ACLs.  Used to enable "unapplication" of unclosed credits.',
1181     'type'        => 'checkbox',
1182   },
1183
1184   {
1185     'key'         => 'dirhash',
1186     'section'     => 'shell',
1187     '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>',
1188     'type'        => 'text',
1189   },
1190
1191   {
1192     'key'         => 'disable_cust_attachment',
1193     'section'     => '',
1194     'description' => 'Disable customer file attachments',
1195     'type'        => 'checkbox',
1196   },
1197
1198   {
1199     'key'         => 'max_attachment_size',
1200     'section'     => '',
1201     'description' => 'Maximum size for customer file attachments (leave blank for unlimited)',
1202     'type'        => 'text',
1203   },
1204
1205   {
1206     'key'         => 'disable_customer_referrals',
1207     'section'     => 'UI',
1208     'description' => 'Disable new customer-to-customer referrals in the web interface',
1209     'type'        => 'checkbox',
1210   },
1211
1212   {
1213     'key'         => 'editreferrals',
1214     'section'     => 'UI',
1215     'description' => 'Enable advertising source modification for existing customers',
1216     'type'        => 'checkbox',
1217   },
1218
1219   {
1220     'key'         => 'emailinvoiceonly',
1221     'section'     => 'invoicing',
1222     'description' => 'Disables postal mail invoices',
1223     'type'        => 'checkbox',
1224   },
1225
1226   {
1227     'key'         => 'disablepostalinvoicedefault',
1228     'section'     => 'invoicing',
1229     '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>.',
1230     'type'        => 'checkbox',
1231   },
1232
1233   {
1234     'key'         => 'emailinvoiceauto',
1235     'section'     => 'invoicing',
1236     'description' => 'Automatically adds new accounts to the email invoice list',
1237     'type'        => 'checkbox',
1238   },
1239
1240   {
1241     'key'         => 'emailinvoiceautoalways',
1242     'section'     => 'invoicing',
1243     'description' => 'Automatically adds new accounts to the email invoice list even when the list contains email addresses',
1244     'type'        => 'checkbox',
1245   },
1246
1247   {
1248     'key'         => 'emailinvoice-apostrophe',
1249     'section'     => 'invoicing',
1250     'description' => 'Allows the apostrophe (single quote) character in the email addresses in the email invoice list.',
1251     'type'        => 'checkbox',
1252   },
1253
1254   {
1255     'key'         => 'svc_acct-ip_addr',
1256     'section'     => '',
1257     'description' => 'Enable IP address management on login services like for broadband services.',
1258     'type'        => 'checkbox',
1259   },
1260
1261   {
1262     'key'         => 'exclude_ip_addr',
1263     'section'     => '',
1264     'description' => 'Exclude these from the list of available broadband service IP addresses. (One per line)',
1265     'type'        => 'textarea',
1266   },
1267
1268   {
1269     'key'         => 'auto_router',
1270     'section'     => '',
1271     'description' => 'Automatically choose the correct router/block based on supplied ip address when possible while provisioning broadband services',
1272     'type'        => 'checkbox',
1273   },
1274
1275   {
1276     'key'         => 'hidecancelledpackages',
1277     'section'     => 'UI',
1278     'description' => 'Prevent cancelled packages from showing up in listings (though they will still be in the database)',
1279     'type'        => 'checkbox',
1280   },
1281
1282   {
1283     'key'         => 'hidecancelledcustomers',
1284     'section'     => 'UI',
1285     'description' => 'Prevent customers with only cancelled packages from showing up in listings (though they will still be in the database)',
1286     'type'        => 'checkbox',
1287   },
1288
1289   {
1290     'key'         => 'home',
1291     'section'     => 'shell',
1292     'description' => 'For new users, prefixed to username to create a directory name.  Should have a leading but not a trailing slash.',
1293     'type'        => 'text',
1294   },
1295
1296   {
1297     'key'         => 'invoice_from',
1298     'section'     => 'required',
1299     'description' => 'Return address on email invoices (address only, see invoice_from_name)',
1300     'type'        => 'text',
1301     'per_agent'   => 1,
1302     'validate'    => $validate_email,
1303   },
1304
1305   {
1306     'key'         => 'invoice_from_name',
1307     'section'     => 'invoicing',
1308     'description' => 'Return name on email invoices (set address in invoice_from)',
1309     'type'        => 'text',
1310     'per_agent'   => 1,
1311     'validate'    => sub { (($_[0] =~ /[^[:alnum:][:space:]]/) && ($_[0] !~ /^\".*\"$/))
1312                            ? 'Invalid name.  Use quotation marks around names that contain punctuation.'
1313                            : '' }
1314   },
1315
1316   {
1317     'key'         => 'quotation_from',
1318     'section'     => '',
1319     'description' => 'Return address on email quotations',
1320     'type'        => 'text',
1321     'per_agent'   => 1,
1322   },
1323
1324
1325   {
1326     'key'         => 'invoice_subject',
1327     'section'     => 'invoicing',
1328     'description' => 'Subject: header on email invoices.  Defaults to "Invoice".  The following substitutions are available: $name, $name_short, $invoice_number, and $invoice_date.',
1329     'type'        => 'text',
1330     'per_agent'   => 1,
1331     'per_locale'  => 1,
1332   },
1333
1334   {
1335     'key'         => 'quotation_subject',
1336     'section'     => '',
1337     'description' => 'Subject: header on email quotations.  Defaults to "Quotation".', #  The following substitutions are available: $name, $name_short, $invoice_number, and $invoice_date.',
1338     'type'        => 'text',
1339     #'per_agent'   => 1,
1340     'per_locale'  => 1,
1341   },
1342
1343   {
1344     'key'         => 'invoice_usesummary',
1345     'section'     => 'invoicing',
1346     'description' => 'Indicates that html and latex invoices should be in summary style and make use of invoice_latexsummary.',
1347     'type'        => 'checkbox',
1348     'per_agent'   => 1,
1349   },
1350
1351   {
1352     'key'         => 'invoice_template',
1353     'section'     => 'invoicing',
1354     '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:3:Documentation:Administration#Plaintext_invoice_templates">billing documentation</a> for details.',
1355     'type'        => 'textarea',
1356   },
1357
1358   {
1359     'key'         => 'invoice_html',
1360     'section'     => 'invoicing',
1361     'description' => '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.',
1362
1363     'type'        => 'textarea',
1364   },
1365
1366   {
1367     'key'         => 'quotation_html',
1368     'section'     => '',
1369     'description' => 'HTML template for quotations.',
1370
1371     'type'        => 'textarea',
1372   },
1373
1374   {
1375     'key'         => 'invoice_htmlnotes',
1376     'section'     => 'invoicing',
1377     'description' => 'Notes section for HTML invoices.  Defaults to the same data in invoice_latexnotes if not specified.',
1378     'type'        => 'textarea',
1379     'per_agent'   => 1,
1380     'per_locale'  => 1,
1381   },
1382
1383   {
1384     'key'         => 'invoice_htmlfooter',
1385     'section'     => 'invoicing',
1386     'description' => 'Footer for HTML invoices.  Defaults to the same data in invoice_latexfooter if not specified.',
1387     'type'        => 'textarea',
1388     'per_agent'   => 1,
1389     'per_locale'  => 1,
1390   },
1391
1392   {
1393     'key'         => 'invoice_htmlsummary',
1394     'section'     => 'invoicing',
1395     'description' => 'Summary initial page for HTML invoices.',
1396     'type'        => 'textarea',
1397     'per_agent'   => 1,
1398     'per_locale'  => 1,
1399   },
1400
1401   {
1402     'key'         => 'invoice_htmlreturnaddress',
1403     'section'     => 'invoicing',
1404     'description' => 'Return address for HTML invoices.  Defaults to the same data in invoice_latexreturnaddress if not specified.',
1405     'type'        => 'textarea',
1406     'per_locale'  => 1,
1407   },
1408
1409   {
1410     'key'         => 'invoice_htmlwatermark',
1411     'section'     => 'invoicing',
1412     'description' => 'Watermark for HTML invoices. Appears in a semitransparent positioned DIV overlaid on the main invoice container.',
1413     'type'        => 'textarea',
1414     'per_agent'   => 1,
1415     'per_locale'  => 1,
1416   },
1417
1418   {
1419     'key'         => 'invoice_latex',
1420     'section'     => 'invoicing',
1421     '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.',
1422     'type'        => 'textarea',
1423   },
1424
1425   {
1426     'key'         => 'quotation_latex',
1427     'section'     => '',
1428     'description' => 'LaTeX template for typeset PostScript quotations.',
1429     'type'        => 'textarea',
1430   },
1431
1432   {
1433     'key'         => 'invoice_latextopmargin',
1434     'section'     => 'invoicing',
1435     'description' => 'Optional LaTeX invoice topmargin setting. Include units.',
1436     'type'        => 'text',
1437     'per_agent'   => 1,
1438     'validate'    => sub { shift =~
1439                              /^-?\d*\.?\d+(in|mm|cm|pt|em|ex|pc|bp|dd|cc|sp)$/
1440                              ? '' : 'Invalid LaTex length';
1441                          },
1442   },
1443
1444   {
1445     'key'         => 'invoice_latexheadsep',
1446     'section'     => 'invoicing',
1447     'description' => 'Optional LaTeX invoice headsep setting. Include units.',
1448     'type'        => 'text',
1449     'per_agent'   => 1,
1450     'validate'    => sub { shift =~
1451                              /^-?\d*\.?\d+(in|mm|cm|pt|em|ex|pc|bp|dd|cc|sp)$/
1452                              ? '' : 'Invalid LaTex length';
1453                          },
1454   },
1455
1456   {
1457     'key'         => 'invoice_latexaddresssep',
1458     'section'     => 'invoicing',
1459     'description' => 'Optional LaTeX invoice separation between invoice header
1460 and customer address. Include units.',
1461     'type'        => 'text',
1462     'per_agent'   => 1,
1463     'validate'    => sub { shift =~
1464                              /^-?\d*\.?\d+(in|mm|cm|pt|em|ex|pc|bp|dd|cc|sp)$/
1465                              ? '' : 'Invalid LaTex length';
1466                          },
1467   },
1468
1469   {
1470     'key'         => 'invoice_latextextheight',
1471     'section'     => 'invoicing',
1472     'description' => 'Optional LaTeX invoice textheight setting. Include units.',
1473     'type'        => 'text',
1474     'per_agent'   => 1,
1475     'validate'    => sub { shift =~
1476                              /^-?\d*\.?\d+(in|mm|cm|pt|em|ex|pc|bp|dd|cc|sp)$/
1477                              ? '' : 'Invalid LaTex length';
1478                          },
1479   },
1480
1481   {
1482     'key'         => 'invoice_latexnotes',
1483     'section'     => 'invoicing',
1484     'description' => 'Notes section for LaTeX typeset PostScript invoices.',
1485     'type'        => 'textarea',
1486     'per_agent'   => 1,
1487     'per_locale'  => 1,
1488   },
1489
1490   {
1491     'key'         => 'quotation_latexnotes',
1492     'section'     => '',
1493     'description' => 'Notes section for LaTeX typeset PostScript quotations.',
1494     'type'        => 'textarea',
1495     'per_agent'   => 1,
1496     'per_locale'  => 1,
1497   },
1498
1499   {
1500     'key'         => 'invoice_latexfooter',
1501     'section'     => 'invoicing',
1502     'description' => 'Footer for LaTeX typeset PostScript invoices.',
1503     'type'        => 'textarea',
1504     'per_agent'   => 1,
1505     'per_locale'  => 1,
1506   },
1507
1508   {
1509     'key'         => 'invoice_latexsummary',
1510     'section'     => 'invoicing',
1511     'description' => 'Summary initial page for LaTeX typeset PostScript invoices.',
1512     'type'        => 'textarea',
1513     'per_agent'   => 1,
1514     'per_locale'  => 1,
1515   },
1516
1517   {
1518     'key'         => 'invoice_latexcoupon',
1519     'section'     => 'invoicing',
1520     'description' => 'Remittance coupon for LaTeX typeset PostScript invoices.',
1521     'type'        => 'textarea',
1522     'per_agent'   => 1,
1523     'per_locale'  => 1,
1524   },
1525
1526   {
1527     'key'         => 'invoice_latexextracouponspace',
1528     'section'     => 'invoicing',
1529     'description' => 'Optional LaTeX invoice textheight space to reserve for a tear off coupon.  Include units.  Default is 2.7 inches.',
1530     'type'        => 'text',
1531     'per_agent'   => 1,
1532     'validate'    => sub { shift =~
1533                              /^-?\d*\.?\d+(in|mm|cm|pt|em|ex|pc|bp|dd|cc|sp)$/
1534                              ? '' : 'Invalid LaTex length';
1535                          },
1536   },
1537
1538   {
1539     'key'         => 'invoice_latexcouponfootsep',
1540     'section'     => 'invoicing',
1541     'description' => 'Optional LaTeX invoice separation between bottom of coupon address and footer. Include units. Default is 0.2 inches.',
1542     'type'        => 'text',
1543     'per_agent'   => 1,
1544     'validate'    => sub { shift =~
1545                              /^-?\d*\.?\d+(in|mm|cm|pt|em|ex|pc|bp|dd|cc|sp)$/
1546                              ? '' : 'Invalid LaTex length';
1547                          },
1548   },
1549
1550   {
1551     'key'         => 'invoice_latexcouponamountenclosedsep',
1552     'section'     => 'invoicing',
1553     'description' => 'Optional LaTeX invoice separation between total due and amount enclosed line. Include units. Default is 2.25 em.',
1554     'type'        => 'text',
1555     'per_agent'   => 1,
1556     'validate'    => sub { shift =~
1557                              /^-?\d*\.?\d+(in|mm|cm|pt|em|ex|pc|bp|dd|cc|sp)$/
1558                              ? '' : 'Invalid LaTex length';
1559                          },
1560   },
1561   {
1562     'key'         => 'invoice_latexcoupontoaddresssep',
1563     'section'     => 'invoicing',
1564     'description' => 'Optional LaTeX invoice separation between invoice data and the address (usually invoice_latexreturnaddress).  Include units. Default is 1 inch.',
1565     'type'        => 'text',
1566     'per_agent'   => 1,
1567     'validate'    => sub { shift =~
1568                              /^-?\d*\.?\d+(in|mm|cm|pt|em|ex|pc|bp|dd|cc|sp)$/
1569                              ? '' : 'Invalid LaTex length';
1570                          },
1571   },
1572
1573   {
1574     'key'         => 'invoice_latexreturnaddress',
1575     'section'     => 'invoicing',
1576     'description' => 'Return address for LaTeX typeset PostScript invoices.',
1577     'type'        => 'textarea',
1578   },
1579
1580   {
1581     'key'         => 'invoice_latexverticalreturnaddress',
1582     'section'     => 'deprecated',
1583     'description' => 'Deprecated.  With old invoice_latex template, places the return address under the company logo rather than beside it.',
1584     'type'        => 'checkbox',
1585     'per_agent'   => 1,
1586   },
1587
1588   {
1589     'key'         => 'invoice_latexcouponaddcompanytoaddress',
1590     'section'     => 'invoicing',
1591     'description' => 'Add the company name to the To address on the remittance coupon because the return address does not contain it.',
1592     'type'        => 'checkbox',
1593     'per_agent'   => 1,
1594   },
1595
1596   {
1597     'key'         => 'invoice_latexsmallfooter',
1598     'section'     => 'invoicing',
1599     'description' => 'Optional small footer for multi-page LaTeX typeset PostScript invoices.',
1600     'type'        => 'textarea',
1601     'per_agent'   => 1,
1602     'per_locale'  => 1,
1603   },
1604
1605   {
1606     'key'         => 'invoice_latexwatermark',
1607     'section'     => 'invoicing',
1608     'description' => 'Watermark for LaTeX invoices. See "texdoc background" for information on what this can contain. The content itself should be enclosed in braces, optionally followed by a comma and any formatting options.',
1609     'type'        => 'textarea',
1610     'per_agent'   => 1,
1611     'per_locale'  => 1,
1612   },
1613
1614   {
1615     'key'         => 'invoice_email_pdf',
1616     'section'     => 'invoicing',
1617     'description' => 'Send PDF invoice as an attachment to emailed invoices.  By default, includes the HTML invoice as the email body, unless invoice_email_pdf_note is set.',
1618     'type'        => 'checkbox'
1619   },
1620
1621   {
1622     'key'         => 'quotation_email_pdf',
1623     'section'     => '',
1624     'description' => 'Send PDF quotations as an attachment to emailed quotations.  By default, includes the HTML quotation as the email body, unless quotation_email_pdf_note is set.',
1625     'type'        => 'checkbox'
1626   },
1627
1628   {
1629     'key'         => 'invoice_email_pdf_msgnum',
1630     'section'     => 'invoicing',
1631     'description' => 'Message template to send as the text and HTML part of PDF invoices. If not selected, a text and HTML version of the invoice will be sent.',
1632     %msg_template_options,
1633   },
1634
1635   {
1636     'key'         => 'invoice_email_pdf_note',
1637     'section'     => 'invoicing',
1638     'description' => 'If defined, this text will replace the default HTML invoice as the body of emailed PDF invoices.',
1639     'type'        => 'textarea'
1640   },
1641
1642   {
1643     'key'         => 'quotation_email_pdf_note',
1644     'section'     => '',
1645     'description' => 'If defined, this text will replace the default HTML quotation as the body of emailed PDF quotations.',
1646     'type'        => 'textarea'
1647   },
1648
1649   {
1650     'key'         => 'quotation_disable_after_days',
1651     'section'     => '',
1652     'description' => 'The number of days, if set, after which a non-converted quotation will be automatically disabled.',
1653     'type'        => 'text'
1654   },
1655
1656   {
1657     'key'         => 'invoice_print_pdf',
1658     'section'     => 'invoicing',
1659     'description' => 'For all invoice print operations, store postal invoices for download in PDF format rather than printing them directly.',
1660     'type'        => 'checkbox',
1661   },
1662
1663   {
1664     'key'         => 'invoice_print_pdf-spoolagent',
1665     'section'     => 'invoicing',
1666     'description' => 'Store postal invoices PDF downloads in per-agent spools.',
1667     'type'        => 'checkbox',
1668   },
1669
1670   {
1671     'key'         => 'invoice_print_pdf-duplex',
1672     'section'     => 'invoicing',
1673     'description' => 'Insert blank pages so that spooled invoices are each an even number of pages.  Use this for double-sided printing.',
1674     'type'        => 'checkbox',
1675   },
1676
1677   {
1678     'key'         => 'invoice_default_terms',
1679     'section'     => 'invoicing',
1680     'description' => 'Optional default invoice term, used to calculate a due date printed on invoices.  WARNING: If you do not want to change the terms on existing invoices, do not change this after going live.',
1681     'type'        => 'select',
1682     'per_agent'   => 1,
1683     'select_enum' => \@invoice_terms,
1684   },
1685
1686   {
1687     'key'         => 'invoice_show_prior_due_date',
1688     'section'     => 'invoicing',
1689     'description' => 'Show previous invoice due dates when showing prior balances.  Default is to show invoice date.',
1690     'type'        => 'checkbox',
1691   },
1692
1693   {
1694     'key'         => 'invoice_omit_due_date',
1695     'section'     => 'invoicing',
1696     'description' => 'Omit the "Please pay by (date)" from invoices.',
1697     'type'        => 'checkbox',
1698     'per_agent'   => 1,
1699   },
1700
1701   {
1702     'key'         => 'invoice_pay_by_msg',
1703     'section'     => 'invoicing',
1704     'description' => 'Test of the "Please pay by (date)" message.  Include [_1] to indicate the date, for example: "Please pay by [_1]"',
1705     'type'        => 'text',
1706     'per_agent'   => 1,
1707   },
1708
1709   {
1710     'key'         => 'invoice_sections',
1711     'section'     => 'invoicing',
1712     'description' => 'Split invoice into sections and label according to either package category or location when enabled.',
1713     'type'        => 'checkbox',
1714     'per_agent'   => 1,
1715     'config_bool' => 1,
1716   },
1717
1718   {
1719     'key'         => 'invoice_sections_multilocation',
1720     'section'     => 'invoicing',
1721     'description' => 'Enable invoice_sections for for any bill with at least this many locations on the bill.',
1722     'type'        => 'text',
1723     'per_agent'   => 1,
1724     'validate'    => sub { shift =~ /^\d+$/ ? undef : 'Please enter a number' },
1725   },
1726
1727   {
1728     'key'         => 'invoice_include_aging',
1729     'section'     => 'invoicing',
1730     'description' => 'Show an aging line after the prior balance section.  Only valid when invoice_sections is enabled.',
1731     'type'        => 'checkbox',
1732   },
1733
1734   {
1735     'key'         => 'invoice_sections_method',
1736     'section'     => 'invoicing',
1737     'description' => 'How to group line items on multi-section invoices.',
1738     'type'        => 'select',
1739     'select_enum' => [ qw(category location) ],
1740   },
1741
1742   {
1743     'key'         => 'invoice_sections_with_taxes',
1744     'section'     => 'invoicing',
1745     'description' => 'Include taxes within each section of mutli-section invoices.',
1746     'type'        => 'checkbox',
1747     'per_agent'   => 1,
1748     'agent_bool'  => 1,
1749   },
1750
1751   {
1752     'key'         => 'summary_subtotals_method',
1753     'section'     => 'invoicing',
1754     'description' => 'How to group line items when calculating summary subtotals.  By default, it will be the same method used for grouping invoice sections.',
1755     'type'        => 'select',
1756     'select_enum' => [ qw(category location) ],
1757   },
1758
1759   #quotations seem broken-ish with sections ATM?
1760   #{
1761   #  'key'         => 'quotation_sections',
1762   #  'section'     => 'invoicing',
1763   #  'description' => 'Split quotations into sections and label according to package category when enabled.',
1764   #  'type'        => 'checkbox',
1765   #  'per_agent'   => 1,
1766   #},
1767
1768   {
1769     'key'         => 'usage_class_summary',
1770     'section'     => 'invoicing',
1771     'description' => 'Summarize total usage by usage class in a separate section.',
1772     'type'        => 'checkbox',
1773   },
1774
1775   {
1776     'key'         => 'usage_class_as_a_section',
1777     'section'     => 'invoicing',
1778     'description' => 'Split usage into sections and label according to usage class name when enabled.  Only valid when invoice_sections is enabled.',
1779     'type'        => 'checkbox',
1780   },
1781
1782   {
1783     'key'         => 'phone_usage_class_summary',
1784     'section'     => 'invoicing',
1785     '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.',
1786     'type'        => 'checkbox',
1787   },
1788
1789   {
1790     'key'         => 'svc_phone_sections',
1791     'section'     => 'invoicing',
1792     'description' => 'Create a section for each svc_phone when enabled.  Only valid when invoice_sections is enabled.',
1793     'type'        => 'checkbox',
1794   },
1795
1796   {
1797     'key'         => 'finance_pkgclass',
1798     'section'     => 'billing',
1799     'description' => 'The default package class for late fee charges, used if the fee event does not specify a package class itself.',
1800     'type'        => 'select-pkg_class',
1801   },
1802
1803   {
1804     'key'         => 'separate_usage',
1805     'section'     => 'invoicing',
1806     'description' => 'Split the rated call usage into a separate line from the recurring charges.',
1807     'type'        => 'checkbox',
1808   },
1809
1810   {
1811     'key'         => 'invoice_send_receipts',
1812     'section'     => 'deprecated',
1813     'description' => '<b>DEPRECATED</b>, this used to send an invoice copy on payments and credits.  See the payment_receipt_email and XXXX instead.',
1814     'type'        => 'checkbox',
1815   },
1816
1817   {
1818     'key'         => 'payment_receipt',
1819     'section'     => 'notification',
1820     'description' => 'Send payment receipts.',
1821     'type'        => 'checkbox',
1822     'per_agent'   => 1,
1823     'agent_bool'  => 1,
1824   },
1825
1826   {
1827     'key'         => 'payment_receipt_statement_mode',
1828     'section'     => 'notification',
1829     'description' => 'Automatic payments will cause a post-payment statement to be sent to the customer. Select the invoice mode to use for this statement. If unspecified, it will use the "_statement" versions of invoice configuration settings, and have the notice name "Statement".',
1830     %invoice_mode_options,
1831   },
1832
1833   {
1834     'key'         => 'payment_receipt_msgnum',
1835     'section'     => 'notification',
1836     'description' => 'Template to use for manual payment receipts.',
1837     %msg_template_options,
1838   },
1839
1840   {
1841     'key'         => 'payment_receipt_from',
1842     'section'     => 'notification',
1843     'description' => 'From: address for payment receipts, if not specified in the template.',
1844     'type'        => 'text',
1845     'per_agent'   => 1,
1846   },
1847
1848   {
1849     'key'         => 'payment_receipt_email',
1850     'section'     => 'deprecated',
1851     'description' => 'Template file for payment receipts.  Payment receipts are sent to the customer email invoice destination(s) when a payment is received.',
1852     'type'        => [qw( checkbox textarea )],
1853   },
1854
1855   {
1856     'key'         => 'payment_receipt-trigger',
1857     'section'     => 'notification',
1858     'description' => 'When payment receipts are triggered.  Defaults to when payment is made.',
1859     'type'        => 'select',
1860     'select_hash' => [
1861                        'cust_pay'          => 'When payment is made.',
1862                        'cust_bill_pay_pkg' => 'When payment is applied.',
1863                      ],
1864     'per_agent'   => 1,
1865   },
1866
1867   {
1868     'key'         => 'refund_receipt_msgnum',
1869     'section'     => 'notification',
1870     'description' => 'Template to use for manual refund receipts.',
1871     %msg_template_options,
1872   },
1873
1874   {
1875     'key'         => 'trigger_export_insert_on_payment',
1876     'section'     => 'billing',
1877     'description' => 'Enable exports on payment application.',
1878     'type'        => 'checkbox',
1879   },
1880
1881   {
1882     'key'         => 'lpr',
1883     'section'     => 'required',
1884     'description' => 'Print command for paper invoices, for example `lpr -h\'',
1885     'type'        => 'text',
1886     'per_agent'   => 1,
1887   },
1888
1889   {
1890     'key'         => 'lpr-postscript_prefix',
1891     'section'     => 'billing',
1892     'description' => 'Raw printer commands prepended to the beginning of postscript print jobs (evaluated as a double-quoted perl string - backslash escapes are available)',
1893     'type'        => 'text',
1894   },
1895
1896   {
1897     'key'         => 'lpr-postscript_suffix',
1898     'section'     => 'billing',
1899     'description' => 'Raw printer commands added to the end of postscript print jobs (evaluated as a double-quoted perl string - backslash escapes are available)',
1900     'type'        => 'text',
1901   },
1902
1903   {
1904     'key'         => 'papersize',
1905     'section'     => 'billing',
1906     'description' => 'Invoice paper size.  Default is "letter" (U.S. standard).  The LaTeX template must be configured to match this size.',
1907     'type'        => 'select',
1908     'select_enum' => [ qw(letter a4) ],
1909   },
1910
1911   {
1912     'key'         => 'money_char',
1913     'section'     => '',
1914     'description' => 'Currency symbol - defaults to `$\'',
1915     'type'        => 'text',
1916   },
1917
1918   {
1919     'key'         => 'defaultrecords',
1920     'section'     => 'BIND',
1921     'description' => 'DNS entries to add automatically when creating a domain',
1922     'type'        => 'editlist',
1923     'editlist_parts' => [ { type=>'text' },
1924                           { type=>'immutable', value=>'IN' },
1925                           { type=>'select',
1926                             select_enum => {
1927                               map { $_=>$_ }
1928                                   #@{ FS::domain_record->rectypes }
1929                                   qw(A AAAA CNAME MX NS PTR SPF SRV TXT)
1930                             },
1931                           },
1932                           { type=> 'text' }, ],
1933   },
1934
1935   {
1936     'key'         => 'passwordmin',
1937     'section'     => 'password',
1938     'description' => 'Minimum password length (default 6)',
1939     'type'        => 'text',
1940   },
1941
1942   {
1943     'key'         => 'passwordmax',
1944     'section'     => 'password',
1945     'description' => 'Maximum password length (default 8) (don\'t set this over 12 if you need to import or export crypt() passwords)',
1946     'type'        => 'text',
1947   },
1948
1949   {
1950     'key'         => 'sip_passwordmin',
1951     'section'     => 'telephony',
1952     'description' => 'Minimum SIP password length (default 6)',
1953     'type'        => 'text',
1954   },
1955
1956   {
1957     'key'         => 'sip_passwordmax',
1958     'section'     => 'telephony',
1959     'description' => 'Maximum SIP password length (default 80)',
1960     'type'        => 'text',
1961   },
1962
1963
1964   {
1965     'key'         => 'password-noampersand',
1966     'section'     => 'password',
1967     'description' => 'Disallow ampersands in passwords',
1968     'type'        => 'checkbox',
1969   },
1970
1971   {
1972     'key'         => 'password-noexclamation',
1973     'section'     => 'password',
1974     'description' => 'Disallow exclamations in passwords (Not setting this could break old text Livingston or Cistron Radius servers)',
1975     'type'        => 'checkbox',
1976   },
1977
1978   {
1979     'key'         => 'default-password-encoding',
1980     'section'     => 'password',
1981     'description' => 'Default storage format for passwords',
1982     'type'        => 'select',
1983     'select_hash' => [
1984       'plain'       => 'Plain text',
1985       'crypt-des'   => 'Unix password (DES encrypted)',
1986       'crypt-md5'   => 'Unix password (MD5 digest)',
1987       'ldap-plain'  => 'LDAP (plain text)',
1988       'ldap-crypt'  => 'LDAP (DES encrypted)',
1989       'ldap-md5'    => 'LDAP (MD5 digest)',
1990       'ldap-sha1'   => 'LDAP (SHA1 digest)',
1991       'legacy'      => 'Legacy mode',
1992     ],
1993   },
1994
1995   {
1996     'key'         => 'referraldefault',
1997     'section'     => 'UI',
1998     'description' => 'Default referral, specified by refnum',
1999     'type'        => 'select-sub',
2000     'options_sub' => sub { require FS::Record;
2001                            require FS::part_referral;
2002                            map { $_->refnum => $_->referral }
2003                                FS::Record::qsearch( 'part_referral',
2004                                                     { 'disabled' => '' }
2005                                                   );
2006                          },
2007     'option_sub'  => sub { require FS::Record;
2008                            require FS::part_referral;
2009                            my $part_referral = FS::Record::qsearchs(
2010                              'part_referral', { 'refnum'=>shift } );
2011                            $part_referral ? $part_referral->referral : '';
2012                          },
2013   },
2014
2015 #  {
2016 #    'key'         => 'registries',
2017 #    'section'     => 'required',
2018 #    'description' => 'Directory which contains domain registry information.  Each registry is a directory.',
2019 #  },
2020
2021   {
2022     'key'         => 'report_template',
2023     'section'     => 'deprecated',
2024     'description' => 'Deprecated template file for reports.',
2025     'type'        => 'textarea',
2026   },
2027
2028   {
2029     'key'         => 'maxsearchrecordsperpage',
2030     'section'     => 'UI',
2031     'description' => 'If set, number of search records to return per page.',
2032     'type'        => 'text',
2033   },
2034
2035   {
2036     'key'         => 'disable_maxselect',
2037     'section'     => 'UI',
2038     'description' => 'Prevent changing the number of records per page.',
2039     'type'        => 'checkbox',
2040   },
2041
2042   {
2043     'key'         => 'session-start',
2044     'section'     => 'session',
2045     '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.',
2046     'type'        => 'text',
2047   },
2048
2049   {
2050     'key'         => 'session-stop',
2051     'section'     => 'session',
2052     '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.',
2053     'type'        => 'text',
2054   },
2055
2056   {
2057     'key'         => 'shells',
2058     'section'     => 'shell',
2059     '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.',
2060     'type'        => 'textarea',
2061   },
2062
2063   {
2064     'key'         => 'showpasswords',
2065     'section'     => 'UI',
2066     'description' => 'Display unencrypted user passwords in the backend (employee) web interface',
2067     'type'        => 'checkbox',
2068   },
2069
2070   {
2071     'key'         => 'report-showpasswords',
2072     'section'     => 'UI',
2073     'description' => 'This is a terrible idea.  Do not enable it.  STRONGLY NOT RECOMMENDED.  Enables display of passwords on services reports.',
2074     'type'        => 'checkbox',
2075   },
2076
2077   {
2078     'key'         => 'signupurl',
2079     'section'     => 'UI',
2080     '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',
2081     'type'        => 'text',
2082   },
2083
2084   {
2085     'key'         => 'smtpmachine',
2086     'section'     => 'required',
2087     'description' => 'SMTP relay for Freeside\'s outgoing mail',
2088     'type'        => 'text',
2089   },
2090
2091   {
2092     'key'         => 'smtp-username',
2093     'section'     => '',
2094     'description' => 'Optional SMTP username for Freeside\'s outgoing mail',
2095     'type'        => 'text',
2096   },
2097
2098   {
2099     'key'         => 'smtp-password',
2100     'section'     => '',
2101     'description' => 'Optional SMTP password for Freeside\'s outgoing mail',
2102     'type'        => 'text',
2103   },
2104
2105   {
2106     'key'         => 'smtp-encryption',
2107     'section'     => '',
2108     'description' => 'Optional SMTP encryption method.  The STARTTLS methods require smtp-username and smtp-password to be set.',
2109     'type'        => 'select',
2110     'select_hash' => [ '25'           => 'None (port 25)',
2111                        '25-starttls'  => 'STARTTLS (port 25)',
2112                        '587-starttls' => 'STARTTLS / submission (port 587)',
2113                        '465-tls'      => 'SMTPS (SSL) (port 465)',
2114                      ],
2115   },
2116
2117   {
2118     'key'         => 'soadefaultttl',
2119     'section'     => 'BIND',
2120     'description' => 'SOA default TTL for new domains.',
2121     'type'        => 'text',
2122   },
2123
2124   {
2125     'key'         => 'soaemail',
2126     'section'     => 'BIND',
2127     'description' => 'SOA email for new domains, in BIND form (`.\' instead of `@\'), with trailing `.\'',
2128     'type'        => 'text',
2129   },
2130
2131   {
2132     'key'         => 'soaexpire',
2133     'section'     => 'BIND',
2134     'description' => 'SOA expire for new domains',
2135     'type'        => 'text',
2136   },
2137
2138   {
2139     'key'         => 'soamachine',
2140     'section'     => 'BIND',
2141     'description' => 'SOA machine for new domains, with trailing `.\'',
2142     'type'        => 'text',
2143   },
2144
2145   {
2146     'key'         => 'soarefresh',
2147     'section'     => 'BIND',
2148     'description' => 'SOA refresh for new domains',
2149     'type'        => 'text',
2150   },
2151
2152   {
2153     'key'         => 'soaretry',
2154     'section'     => 'BIND',
2155     'description' => 'SOA retry for new domains',
2156     'type'        => 'text',
2157   },
2158
2159   {
2160     'key'         => 'statedefault',
2161     'section'     => 'UI',
2162     'description' => 'Default state or province (if not supplied, the default is `CA\')',
2163     'type'        => 'text',
2164   },
2165
2166   {
2167     'key'         => 'unsuspend_balance',
2168     'section'     => 'billing',
2169     'description' => 'Enables the automatic unsuspension of suspended packages when a customer\'s balance due is at or below the specified amount after a payment or credit',
2170     'type'        => 'select',
2171     'select_enum' => [
2172       '', 'Zero', 'Latest invoice charges', 'Charges not past due'
2173     ],
2174   },
2175
2176   {
2177     'key'         => 'unsuspend-always_adjust_next_bill_date',
2178     'section'     => 'billing',
2179     '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.',
2180     'type'        => 'checkbox',
2181   },
2182
2183   {
2184     'key'         => 'usernamemin',
2185     'section'     => 'username',
2186     'description' => 'Minimum username length (default 2)',
2187     'type'        => 'text',
2188   },
2189
2190   {
2191     'key'         => 'usernamemax',
2192     'section'     => 'username',
2193     'description' => 'Maximum username length',
2194     'type'        => 'text',
2195   },
2196
2197   {
2198     'key'         => 'username-ampersand',
2199     'section'     => 'username',
2200     '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.',
2201     'type'        => 'checkbox',
2202   },
2203
2204   {
2205     'key'         => 'username-letter',
2206     'section'     => 'username',
2207     'description' => 'Usernames must contain at least one letter',
2208     'type'        => 'checkbox',
2209     'per_agent'   => 1,
2210   },
2211
2212   {
2213     'key'         => 'username-letterfirst',
2214     'section'     => 'username',
2215     'description' => 'Usernames must start with a letter',
2216     'type'        => 'checkbox',
2217   },
2218
2219   {
2220     'key'         => 'username-noperiod',
2221     'section'     => 'username',
2222     'description' => 'Disallow periods in usernames',
2223     'type'        => 'checkbox',
2224   },
2225
2226   {
2227     'key'         => 'username-nounderscore',
2228     'section'     => 'username',
2229     'description' => 'Disallow underscores in usernames',
2230     'type'        => 'checkbox',
2231   },
2232
2233   {
2234     'key'         => 'username-nodash',
2235     'section'     => 'username',
2236     'description' => 'Disallow dashes in usernames',
2237     'type'        => 'checkbox',
2238   },
2239
2240   {
2241     'key'         => 'username-uppercase',
2242     'section'     => 'username',
2243     'description' => 'Allow uppercase characters in usernames.  Not recommended for use with FreeRADIUS with MySQL backend, which is case-insensitive by default.',
2244     'type'        => 'checkbox',
2245     'per_agent'   => 1,
2246   },
2247
2248   {
2249     'key'         => 'username-percent',
2250     'section'     => 'username',
2251     'description' => 'Allow the percent character (%) in usernames.',
2252     'type'        => 'checkbox',
2253   },
2254
2255   {
2256     'key'         => 'username-colon',
2257     'section'     => 'username',
2258     'description' => 'Allow the colon character (:) in usernames.',
2259     'type'        => 'checkbox',
2260   },
2261
2262   {
2263     'key'         => 'username-slash',
2264     'section'     => 'username',
2265     '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.',
2266     'type'        => 'checkbox',
2267   },
2268
2269   {
2270     'key'         => 'username-equals',
2271     'section'     => 'username',
2272     'description' => 'Allow the equal sign character (=) in usernames.',
2273     'type'        => 'checkbox',
2274   },
2275
2276   {
2277     'key'         => 'safe-part_bill_event',
2278     'section'     => 'UI',
2279     'description' => 'Validates invoice event expressions against a preset list.  Useful for webdemos, annoying to powerusers.',
2280     'type'        => 'checkbox',
2281   },
2282
2283   {
2284     'key'         => 'google_maps_api_key',
2285     'section'     => 'UI',
2286     'description' => 'API key for google maps.  This must be set for map and directions links to work.  See <a href="https://developers.google.com/maps/documentation/javascript/get-api-key" target="_top">Getting a Google Maps API Key</a>',
2287     'type'        => 'text',
2288   },
2289
2290   {
2291     'key'         => 'company_physical_address',
2292     'section'     => 'UI',
2293     'description' => 'Your physical company address, for use in supplying google map directions, defaults to company_address',
2294     'type'        => 'textarea',
2295     'per_agent'   => 1,
2296   },
2297
2298   {
2299     'key'         => 'show_ship_company',
2300     'section'     => 'UI',
2301     'description' => 'Turns on display/collection of a "service company name" field for customers.',
2302     'type'        => 'checkbox',
2303   },
2304
2305   {
2306     'key'         => 'show_ss',
2307     'section'     => 'UI',
2308     'description' => 'Turns on display/collection of social security numbers in the web interface.  Sometimes required by electronic check (ACH) processors.',
2309     'type'        => 'checkbox',
2310   },
2311
2312   {
2313     'key'         => 'unmask_ss',
2314     'section'     => 'UI',
2315     'description' => "Don't mask social security numbers in the web interface.",
2316     'type'        => 'checkbox',
2317   },
2318
2319   {
2320     'key'         => 'show_stateid',
2321     'section'     => 'UI',
2322     'description' => "Turns on display/collection of driver's license/state issued id numbers in the web interface.  Sometimes required by electronic check (ACH) processors.",
2323     'type'        => 'checkbox',
2324   },
2325
2326   {
2327     'key'         => 'national_id-country',
2328     'section'     => 'UI',
2329     'description' => 'Track a national identification number, for specific countries.',
2330     'type'        => 'select',
2331     'select_enum' => [ '', 'MY' ],
2332   },
2333
2334   {
2335     'key'         => 'show_bankstate',
2336     'section'     => 'UI',
2337     'description' => "Turns on display/collection of state for bank accounts in the web interface.  Sometimes required by electronic check (ACH) processors.",
2338     'type'        => 'checkbox',
2339   },
2340
2341   {
2342     'key'         => 'agent_defaultpkg',
2343     'section'     => 'UI',
2344     'description' => 'Setting this option will cause new packages to be available to all agent types by default.',
2345     'type'        => 'checkbox',
2346   },
2347
2348   {
2349     'key'         => 'legacy_link',
2350     'section'     => 'UI',
2351     'description' => 'Display options in the web interface to link legacy pre-Freeside services.',
2352     'type'        => 'checkbox',
2353   },
2354
2355   {
2356     'key'         => 'legacy_link-steal',
2357     'section'     => 'UI',
2358     'description' => 'Allow "stealing" an already-audited service from one customer (or package) to another using the link function.',
2359     'type'        => 'checkbox',
2360   },
2361
2362   {
2363     'key'         => 'queue_dangerous_controls',
2364     'section'     => 'UI',
2365     '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.',
2366     'type'        => 'checkbox',
2367   },
2368
2369   {
2370     'key'         => 'security_phrase',
2371     'section'     => 'password',
2372     'description' => 'Enable the tracking of a "security phrase" with each account.  Not recommended, as it is vulnerable to social engineering.',
2373     'type'        => 'checkbox',
2374   },
2375
2376   {
2377     'key'         => 'locale',
2378     'section'     => 'UI',
2379     'description' => 'Default locale',
2380     'type'        => 'select-sub',
2381     'options_sub' => sub {
2382       map { $_ => FS::Locales->description($_) } FS::Locales->locales;
2383     },
2384     'option_sub'  => sub {
2385       FS::Locales->description(shift)
2386     },
2387   },
2388
2389   {
2390     'key'         => 'signup_server-payby',
2391     'section'     => 'self-service',
2392     'description' => 'Acceptable payment types for the signup server',
2393     'type'        => 'selectmultiple',
2394     'select_enum' => [ qw(CARD DCRD CHEK DCHK LECB PREPAY PPAL BILL COMP) ],
2395   },
2396
2397   {
2398     'key'         => 'selfservice-payment_gateway',
2399     'section'     => 'self-service',
2400     'description' => 'Force the use of this payment gateway for self-service.',
2401     %payment_gateway_options,
2402   },
2403
2404   {
2405     'key'         => 'selfservice-save_unchecked',
2406     'section'     => 'self-service',
2407     'description' => 'In self-service, uncheck "Remember information" checkboxes by default (normally, they are checked by default).',
2408     'type'        => 'checkbox',
2409   },
2410
2411   {
2412     'key'         => 'default_agentnum',
2413     'section'     => 'UI',
2414     'description' => 'Default agent for the backoffice',
2415     'type'        => 'select-agent',
2416   },
2417
2418   {
2419     'key'         => 'signup_server-default_agentnum',
2420     'section'     => 'self-service',
2421     'description' => 'Default agent for the signup server',
2422     'type'        => 'select-agent',
2423   },
2424
2425   {
2426     'key'         => 'signup_server-default_refnum',
2427     'section'     => 'self-service',
2428     'description' => 'Default advertising source for the signup server',
2429     'type'        => 'select-sub',
2430     'options_sub' => sub { require FS::Record;
2431                            require FS::part_referral;
2432                            map { $_->refnum => $_->referral }
2433                                FS::Record::qsearch( 'part_referral',
2434                                                     { 'disabled' => '' }
2435                                                   );
2436                          },
2437     'option_sub'  => sub { require FS::Record;
2438                            require FS::part_referral;
2439                            my $part_referral = FS::Record::qsearchs(
2440                              'part_referral', { 'refnum'=>shift } );
2441                            $part_referral ? $part_referral->referral : '';
2442                          },
2443   },
2444
2445   {
2446     'key'         => 'signup_server-default_pkgpart',
2447     'section'     => 'self-service',
2448     'description' => 'Default package for the signup server',
2449     'type'        => 'select-part_pkg',
2450   },
2451
2452   {
2453     'key'         => 'signup_server-default_svcpart',
2454     'section'     => 'self-service',
2455     'description' => 'Default service definition for the signup server - only necessary for services that trigger special provisioning widgets (such as DID provisioning or domain selection).',
2456     'type'        => 'select-part_svc',
2457   },
2458
2459   {
2460     'key'         => 'signup_server-default_domsvc',
2461     'section'     => 'self-service',
2462     'description' => 'If specified, the default domain svcpart for signup (useful when domain is set to selectable choice).',
2463     'type'        => 'text',
2464   },
2465
2466   {
2467     'key'         => 'signup_server-mac_addr_svcparts',
2468     'section'     => 'self-service',
2469     'description' => 'Service definitions which can receive mac addresses (current mapped to username for svc_acct).',
2470     'type'        => 'select-part_svc',
2471     'multiple'    => 1,
2472   },
2473
2474   {
2475     'key'         => 'signup_server-nomadix',
2476     'section'     => 'self-service',
2477     'description' => 'Signup page Nomadix integration',
2478     'type'        => 'checkbox',
2479   },
2480
2481   {
2482     'key'         => 'signup_server-service',
2483     'section'     => 'self-service',
2484     'description' => 'Service for the signup server - "Account (svc_acct)" is the default setting, or "Phone number (svc_phone)" for ITSP signup',
2485     'type'        => 'select',
2486     'select_hash' => [
2487                        'svc_acct'  => 'Account (svc_acct)',
2488                        'svc_phone' => 'Phone number (svc_phone)',
2489                        'svc_pbx'   => 'PBX (svc_pbx)',
2490                        'none'      => 'None - package only',
2491                      ],
2492   },
2493
2494   {
2495     'key'         => 'signup_server-prepaid-template-custnum',
2496     'section'     => 'self-service',
2497     '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',
2498     'type'        => 'text',
2499   },
2500
2501   {
2502     'key'         => 'signup_server-terms_of_service',
2503     'section'     => 'self-service',
2504     'description' => 'Terms of Service for the signup server.  May contain HTML.',
2505     'type'        => 'textarea',
2506     'per_agent'   => 1,
2507   },
2508
2509   {
2510     'key'         => 'selfservice_server-base_url',
2511     'section'     => 'self-service',
2512     '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.',
2513     'type'        => 'text',
2514   },
2515
2516   {
2517     'key'         => 'show-msgcat-codes',
2518     'section'     => 'UI',
2519     'description' => 'Show msgcat codes in error messages.  Turn this option on before reporting errors to the mailing list.',
2520     'type'        => 'checkbox',
2521   },
2522
2523   {
2524     'key'         => 'signup_server-realtime',
2525     'section'     => 'self-service',
2526     'description' => 'Run billing for signup server signups immediately, and do not provision accounts which subsequently have a balance.',
2527     'type'        => 'checkbox',
2528   },
2529
2530   {
2531     'key'         => 'signup_server-classnum2',
2532     'section'     => 'self-service',
2533     'description' => 'Package Class for first optional purchase',
2534     'type'        => 'select-pkg_class',
2535   },
2536
2537   {
2538     'key'         => 'signup_server-classnum3',
2539     'section'     => 'self-service',
2540     'description' => 'Package Class for second optional purchase',
2541     'type'        => 'select-pkg_class',
2542   },
2543
2544   {
2545     'key'         => 'signup_server-third_party_as_card',
2546     'section'     => 'self-service',
2547     'description' => 'Allow customer payment type to be set to CARD even when using third-party credit card billing.',
2548     'type'        => 'checkbox',
2549   },
2550
2551   {
2552     'key'         => 'selfservice-xmlrpc',
2553     'section'     => 'self-service',
2554     'description' => 'Run a standalone self-service XML-RPC server on the backend (on port 8080).',
2555     'type'        => 'checkbox',
2556   },
2557
2558   {
2559     'key'         => 'selfservice-timeout',
2560     'section'     => 'self-service',
2561     'description' => 'Timeout for the self-service login cookie, in seconds.  Defaults to 1 hour.',
2562     'type'        => 'text',
2563   },
2564
2565   {
2566     'key'         => 'backend-realtime',
2567     'section'     => 'billing',
2568     'description' => 'Run billing for backend signups immediately.',
2569     'type'        => 'checkbox',
2570   },
2571
2572   {
2573     'key'         => 'decline_msgnum',
2574     'section'     => 'notification',
2575     'description' => 'Template to use for credit card and electronic check decline messages.',
2576     %msg_template_options,
2577   },
2578
2579   {
2580     'key'         => 'declinetemplate',
2581     'section'     => 'deprecated',
2582     'description' => 'Template file for credit card and electronic check decline emails.',
2583     'type'        => 'textarea',
2584   },
2585
2586   {
2587     'key'         => 'emaildecline',
2588     'section'     => 'notification',
2589     'description' => 'Enable emailing of credit card and electronic check decline notices.',
2590     'type'        => 'checkbox',
2591     'per_agent'   => 1,
2592   },
2593
2594   {
2595     'key'         => 'emaildecline-exclude',
2596     'section'     => 'notification',
2597     'description' => 'List of error messages that should not trigger email decline notices, one per line.',
2598     'type'        => 'textarea',
2599     'per_agent'   => 1,
2600   },
2601
2602   {
2603     'key'         => 'cancel_msgnum',
2604     'section'     => 'notification',
2605     'description' => 'Template to use for cancellation emails.',
2606     %msg_template_options,
2607   },
2608
2609   {
2610     'key'         => 'cancelmessage',
2611     'section'     => 'deprecated',
2612     'description' => 'Template file for cancellation emails.',
2613     'type'        => 'textarea',
2614   },
2615
2616   {
2617     'key'         => 'cancelsubject',
2618     'section'     => 'deprecated',
2619     'description' => 'Subject line for cancellation emails.',
2620     'type'        => 'text',
2621   },
2622
2623   {
2624     'key'         => 'emailcancel',
2625     'section'     => 'notification',
2626     'description' => 'Enable emailing of cancellation notices.  Make sure to select the template in the cancel_msgnum option.',
2627     'type'        => 'checkbox',
2628     'per_agent'   => 1,
2629   },
2630
2631   {
2632     'key'         => 'bill_usage_on_cancel',
2633     'section'     => 'billing',
2634     '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.',
2635     'type'        => 'checkbox',
2636   },
2637
2638   {
2639     'key'         => 'cancel_msgnum-referring_cust-pkg_class',
2640     'section'     => 'notification',
2641     'description' => 'Enable cancellation messages to the referring customer for these package classes.',
2642     'type'        => 'select-pkg_class',
2643     'multiple'    => 1,
2644   },
2645
2646   {
2647     'key'         => 'cancel_msgnum-referring_cust',
2648     'section'     => 'notification',
2649     'description' => 'Template to use for cancellation emails sent to the referring customer.',
2650     %msg_template_options,
2651   },
2652
2653   {
2654     'key'         => 'require_cardname',
2655     'section'     => 'billing',
2656     'description' => 'Require an "Exact name on card" to be entered explicitly; don\'t default to using the first and last name.',
2657     'type'        => 'checkbox',
2658   },
2659
2660   {
2661     'key'         => 'enable_taxclasses',
2662     'section'     => 'billing',
2663     'description' => 'Enable per-package tax classes',
2664     'type'        => 'checkbox',
2665   },
2666
2667   {
2668     'key'         => 'require_taxclasses',
2669     'section'     => 'billing',
2670     'description' => 'Require a taxclass to be entered for every package',
2671     'type'        => 'checkbox',
2672   },
2673
2674   {
2675     'key'         => 'enable_taxproducts',
2676     'section'     => 'billing',
2677     'description' => 'Enable per-package mapping to vendor tax data from CCH or elsewhere.',
2678     'type'        => 'checkbox',
2679   },
2680
2681   {
2682     'key'         => 'taxdatadirectdownload',
2683     'section'     => 'billing',  #well
2684     'description' => 'Enable downloading tax data directly from the vendor site. at least three lines: URL, username, and password.j',
2685     'type'        => 'textarea',
2686   },
2687
2688   {
2689     'key'         => 'ignore_incalculable_taxes',
2690     'section'     => 'billing',
2691     'description' => 'Prefer to invoice without tax over not billing at all',
2692     'type'        => 'checkbox',
2693   },
2694
2695   {
2696     'key'         => 'welcome_msgnum',
2697     'section'     => 'notification',
2698     'description' => 'Template to use for welcome messages when a svc_acct record is created.',
2699     %msg_template_options,
2700   },
2701
2702   {
2703     'key'         => 'svc_acct_welcome_exclude',
2704     'section'     => 'notification',
2705     'description' => 'A list of svc_acct services for which no welcome email is to be sent.',
2706     'type'        => 'select-part_svc',
2707     'multiple'    => 1,
2708   },
2709
2710   {
2711     'key'         => 'welcome_email',
2712     'section'     => 'deprecated',
2713     '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.',
2714     'type'        => 'textarea',
2715     'per_agent'   => 1,
2716   },
2717
2718   {
2719     'key'         => 'welcome_email-from',
2720     'section'     => 'deprecated',
2721     'description' => 'From: address header for welcome email',
2722     'type'        => 'text',
2723     'per_agent'   => 1,
2724   },
2725
2726   {
2727     'key'         => 'welcome_email-subject',
2728     'section'     => 'deprecated',
2729     'description' => 'Subject: header for welcome email',
2730     'type'        => 'text',
2731     'per_agent'   => 1,
2732   },
2733
2734   {
2735     'key'         => 'welcome_email-mimetype',
2736     'section'     => 'deprecated',
2737     'description' => 'MIME type for welcome email',
2738     'type'        => 'select',
2739     'select_enum' => [ 'text/plain', 'text/html' ],
2740     'per_agent'   => 1,
2741   },
2742
2743   {
2744     'key'         => 'welcome_letter',
2745     'section'     => '',
2746     '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>',
2747     'type'        => 'textarea',
2748   },
2749
2750 #  {
2751 #    'key'         => 'warning_msgnum',
2752 #    'section'     => 'notification',
2753 #    '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.',
2754 #    %msg_template_options,
2755 #  },
2756
2757   {
2758     'key'         => 'warning_email',
2759     'section'     => 'notification',
2760     '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>',
2761     'type'        => 'textarea',
2762   },
2763
2764   {
2765     'key'         => 'warning_email-from',
2766     'section'     => 'notification',
2767     'description' => 'From: address header for warning email',
2768     'type'        => 'text',
2769   },
2770
2771   {
2772     'key'         => 'warning_email-cc',
2773     'section'     => 'notification',
2774     'description' => 'Additional recipient(s) (comma separated) for warning email when remaining usage reaches zero.',
2775     'type'        => 'text',
2776   },
2777
2778   {
2779     'key'         => 'warning_email-subject',
2780     'section'     => 'notification',
2781     'description' => 'Subject: header for warning email',
2782     'type'        => 'text',
2783   },
2784
2785   {
2786     'key'         => 'warning_email-mimetype',
2787     'section'     => 'notification',
2788     'description' => 'MIME type for warning email',
2789     'type'        => 'select',
2790     'select_enum' => [ 'text/plain', 'text/html' ],
2791   },
2792
2793   {
2794     'key'         => 'payby',
2795     'section'     => 'billing',
2796     'description' => 'Available payment types.',
2797     'type'        => 'selectmultiple',
2798     'select_enum' => [ qw(CARD DCRD CHEK DCHK LECB BILL CASH WEST MCRD MCHK PPAL COMP) ],
2799   },
2800
2801   {
2802     'key'         => 'payby-default',
2803     'section'     => 'UI',
2804     'description' => 'Default payment type.  HIDE disables display of billing information and sets customers to BILL.',
2805     'type'        => 'select',
2806     'select_enum' => [ '', qw(CARD DCRD CHEK DCHK LECB BILL CASH WEST MCRD PPAL COMP HIDE) ],
2807   },
2808
2809   {
2810     'key'         => 'require_cash_deposit_info',
2811     'section'     => 'billing',
2812     'description' => 'When recording cash payments, display bank deposit information fields.',
2813     'type'        => 'checkbox',
2814   },
2815
2816   {
2817     'key'         => 'paymentforcedtobatch',
2818     'section'     => 'deprecated',
2819     '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.',
2820     'type'        => 'checkbox',
2821   },
2822
2823   {
2824     'key'         => 'svc_acct-notes',
2825     'section'     => 'deprecated',
2826     'description' => 'Extra HTML to be displayed on the Account View screen.',
2827     'type'        => 'textarea',
2828   },
2829
2830   {
2831     'key'         => 'radius-password',
2832     'section'     => '',
2833     'description' => 'RADIUS attribute for plain-text passwords.',
2834     'type'        => 'select',
2835     'select_enum' => [ 'Password', 'User-Password', 'Cleartext-Password' ],
2836   },
2837
2838   {
2839     'key'         => 'radius-ip',
2840     'section'     => '',
2841     'description' => 'RADIUS attribute for IP addresses.',
2842     'type'        => 'select',
2843     'select_enum' => [ 'Framed-IP-Address', 'Framed-Address' ],
2844   },
2845
2846   #http://dev.coova.org/svn/coova-chilli/doc/dictionary.chillispot
2847   {
2848     'key'         => 'radius-chillispot-max',
2849     'section'     => '',
2850     'description' => 'Enable ChilliSpot (and CoovaChilli) Max attributes, specifically ChilliSpot-Max-{Input,Output,Total}-{Octets,Gigawords}.',
2851     'type'        => 'checkbox',
2852   },
2853
2854   {
2855     'key'         => 'radius-canopy',
2856     'section'     => '',
2857     'description' => 'Enable RADIUS attributes for Cambium (formerly Motorola) Canopy (Motorola-Canopy-Gateway).',
2858     'type'        => 'checkbox',
2859   },
2860
2861   {
2862     'key'         => 'svc_broadband-radius',
2863     'section'     => '',
2864     'description' => 'Enable RADIUS groups for broadband services.',
2865     'type'        => 'checkbox',
2866   },
2867
2868   {
2869     'key'         => 'svc_acct-alldomains',
2870     'section'     => '',
2871     '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.',
2872     'type'        => 'checkbox',
2873   },
2874
2875   {
2876     'key'         => 'dump-localdest',
2877     'section'     => '',
2878     'description' => 'Destination for local database dumps (full path)',
2879     'type'        => 'text',
2880   },
2881
2882   {
2883     'key'         => 'dump-scpdest',
2884     'section'     => '',
2885     'description' => 'Destination for scp database dumps: user@host:/path',
2886     'type'        => 'text',
2887   },
2888
2889   {
2890     'key'         => 'dump-pgpid',
2891     'section'     => '',
2892     '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.",
2893     'type'        => 'text',
2894   },
2895
2896   {
2897     'key'         => 'dump-email_to',
2898     'section'     => '',
2899     'description' => "Optional email address to send success/failure message for database dumps.",
2900     'type'        => 'text',
2901     'validate'    => $validate_email,
2902   },
2903
2904   {
2905     'key'         => 'users-allow_comp',
2906     'section'     => 'deprecated',
2907     '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.',
2908     'type'        => 'textarea',
2909   },
2910
2911   {
2912     'key'         => 'credit_card-recurring_billing_flag',
2913     'section'     => 'billing',
2914     '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. ',
2915     'type'        => 'select',
2916     'select_hash' => [
2917                        'actual_oncard' => 'Default/classic behavior: set the flag if a customer has actual previous charges on the card.',
2918                        'transaction_is_recur' => 'Set the flag if the transaction itself is recurring, irregardless of previous charges on the card.',
2919                      ],
2920   },
2921
2922   {
2923     'key'         => 'credit_card-recurring_billing_acct_code',
2924     'section'     => 'billing',
2925     'description' => 'When the "recurring billing" flag is set, also set the "acct_code" to "rebill".  Useful for reporting purposes with supported gateways (PlugNPay, others?)',
2926     'type'        => 'checkbox',
2927   },
2928
2929   {
2930     'key'         => 'cvv-save',
2931     'section'     => 'billing',
2932     'description' => 'NOT RECOMMENDED.  Saves CVV2 information after the initial transaction for the selected credit card types.  Enabling this option is almost certainly in violation of your merchant agreement(s), so please check them carefully before enabling this option for any credit card types.',
2933     'type'        => 'selectmultiple',
2934     'select_enum' => \@card_types,
2935   },
2936
2937   {
2938     'key'         => 'signup-require_cvv',
2939     'section'     => 'self-service',
2940     'description' => 'Require CVV for credit card signup.',
2941     'type'        => 'checkbox',
2942   },
2943
2944   {
2945     'key'         => 'backoffice-require_cvv',
2946     'section'     => 'billing',
2947     'description' => 'Require CVV for manual credit card entry.',
2948     'type'        => 'checkbox',
2949   },
2950
2951   {
2952     'key'         => 'selfservice-onfile_require_cvv',
2953     'section'     => 'self-service',
2954     'description' => 'Require CVV for on-file credit card during self-service payments.',
2955     'type'        => 'checkbox',
2956   },
2957
2958   {
2959     'key'         => 'selfservice-require_cvv',
2960     'section'     => 'self-service',
2961     'description' => 'Require CVV for credit card self-service payments, except for cards on-file.',
2962     'type'        => 'checkbox',
2963   },
2964
2965   {
2966     'key'         => 'manual_process-single_invoice_amount',
2967     'section'     => 'billing',
2968     'description' => 'When entering manual credit card and ACH payments, amount will not autofill if the customer has more than one open invoice',
2969     'type'        => 'checkbox',
2970   },
2971
2972   {
2973     'key'         => 'manual_process-pkgpart',
2974     'section'     => 'billing',
2975     'description' => 'Package to add to each manual credit card and ACH payment entered by employees from the backend.  Enabling this option may be in violation of your merchant agreement(s), so please check it(/them) carefully before enabling this option.',
2976     'type'        => 'select-part_pkg',
2977     'per_agent'   => 1,
2978   },
2979
2980   {
2981     'key'         => 'manual_process-display',
2982     'section'     => 'billing',
2983     'description' => 'When using manual_process-pkgpart, add the fee to the amount entered (default), or subtract the fee from the amount entered.',
2984     'type'        => 'select',
2985     'select_hash' => [
2986                        'add'      => 'Add fee to amount entered',
2987                        'subtract' => 'Subtract fee from amount entered',
2988                      ],
2989   },
2990
2991   {
2992     'key'         => 'manual_process-skip_first',
2993     'section'     => 'billing',
2994     'description' => "When using manual_process-pkgpart, omit the fee if it is the customer's first payment.",
2995     'type'        => 'checkbox',
2996   },
2997
2998   {
2999     'key'         => 'selfservice_immutable-package',
3000     'section'     => 'self-service',
3001     'description' => 'Disable package changes in self-service interface.',
3002     'type'        => 'checkbox',
3003     'per_agent'   => 1,
3004   },
3005
3006   {
3007     'key'         => 'selfservice_hide-usage',
3008     'section'     => 'self-service',
3009     'description' => 'Hide usage data in self-service interface.',
3010     'type'        => 'checkbox',
3011     'per_agent'   => 1,
3012   },
3013
3014   {
3015     'key'         => 'selfservice_process-pkgpart',
3016     'section'     => 'billing',
3017     'description' => 'Package to add to each manual credit card and ACH payment entered by the customer themselves in the self-service interface.  Enabling this option may be in violation of your merchant agreement(s), so please check it(/them) carefully before enabling this option.',
3018     'type'        => 'select-part_pkg',
3019     'per_agent'   => 1,
3020   },
3021
3022   {
3023     'key'         => 'selfservice_process-display',
3024     'section'     => 'billing',
3025     'description' => 'When using selfservice_process-pkgpart, add the fee to the amount entered (default), or subtract the fee from the amount entered.',
3026     'type'        => 'select',
3027     'select_hash' => [
3028                        'add'      => 'Add fee to amount entered',
3029                        'subtract' => 'Subtract fee from amount entered',
3030                      ],
3031   },
3032
3033   {
3034     'key'         => 'selfservice_process-skip_first',
3035     'section'     => 'billing',
3036     'description' => "When using selfservice_process-pkgpart, omit the fee if it is the customer's first payment.",
3037     'type'        => 'checkbox',
3038   },
3039
3040 #  {
3041 #    'key'         => 'auto_process-pkgpart',
3042 #    'section'     => 'billing',
3043 #    'description' => 'Package to add to each automatic credit card and ACH payment processed by billing events.  Enabling this option may be in violation of your merchant agreement(s), so please check them carefully before enabling this option.',
3044 #    'type'        => 'select-part_pkg',
3045 #  },
3046 #
3047 ##  {
3048 ##    'key'         => 'auto_process-display',
3049 ##    'section'     => 'billing',
3050 ##    'description' => 'When using auto_process-pkgpart, add the fee to the amount entered (default), or subtract the fee from the amount entered.',
3051 ##    'type'        => 'select',
3052 ##    'select_hash' => [
3053 ##                       'add'      => 'Add fee to amount entered',
3054 ##                       'subtract' => 'Subtract fee from amount entered',
3055 ##                     ],
3056 ##  },
3057 #
3058 #  {
3059 #    'key'         => 'auto_process-skip_first',
3060 #    'section'     => 'billing',
3061 #    'description' => "When using auto_process-pkgpart, omit the fee if it is the customer's first payment.",
3062 #    'type'        => 'checkbox',
3063 #  },
3064
3065   {
3066     'key'         => 'allow_negative_charges',
3067     'section'     => 'billing',
3068     'description' => 'Allow negative charges.  Normally not used unless importing data from a legacy system that requires this.',
3069     'type'        => 'checkbox',
3070   },
3071   {
3072       'key'         => 'auto_unset_catchall',
3073       'section'     => '',
3074       '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.',
3075       'type'        => 'checkbox',
3076   },
3077
3078   {
3079     'key'         => 'system_usernames',
3080     'section'     => 'username',
3081     '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.',
3082     'type'        => 'textarea',
3083   },
3084
3085   {
3086     'key'         => 'cust_pkg-change_svcpart',
3087     'section'     => '',
3088     'description' => "When changing packages, move services even if svcparts don't match between old and new pacakge definitions.",
3089     'type'        => 'checkbox',
3090   },
3091
3092   {
3093     'key'         => 'cust_pkg-change_pkgpart-bill_now',
3094     'section'     => '',
3095     '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.",
3096     'type'        => 'checkbox',
3097   },
3098
3099   {
3100     'key'         => 'disable_autoreverse',
3101     'section'     => 'BIND',
3102     'description' => 'Disable automatic synchronization of reverse-ARPA entries.',
3103     'type'        => 'checkbox',
3104   },
3105
3106   {
3107     'key'         => 'svc_www-enable_subdomains',
3108     'section'     => '',
3109     'description' => 'Enable selection of specific subdomains for virtual host creation.',
3110     'type'        => 'checkbox',
3111   },
3112
3113   {
3114     'key'         => 'svc_www-usersvc_svcpart',
3115     'section'     => '',
3116     'description' => 'Allowable service definition svcparts for virtual hosts, one per line.',
3117     'type'        => 'select-part_svc',
3118     'multiple'    => 1,
3119   },
3120
3121   {
3122     'key'         => 'selfservice_server-primary_only',
3123     'section'     => 'self-service',
3124     'description' => 'Only allow primary accounts to access self-service functionality.',
3125     'type'        => 'checkbox',
3126   },
3127
3128   {
3129     'key'         => 'selfservice_server-phone_login',
3130     'section'     => 'self-service',
3131     'description' => 'Allow login to self-service with phone number and PIN.',
3132     'type'        => 'checkbox',
3133   },
3134
3135   {
3136     'key'         => 'selfservice_server-single_domain',
3137     'section'     => 'self-service',
3138     'description' => 'If specified, only use this one domain for self-service access.',
3139     'type'        => 'text',
3140   },
3141
3142   {
3143     'key'         => 'selfservice_server-login_svcpart',
3144     'section'     => 'self-service',
3145     'description' => 'If specified, only allow the specified svcparts to login to self-service.',
3146     'type'        => 'select-part_svc',
3147     'multiple'    => 1,
3148   },
3149
3150   {
3151     'key'         => 'selfservice-svc_forward_svcpart',
3152     'section'     => 'self-service',
3153     'description' => 'Service for self-service forward editing.',
3154     'type'        => 'select-part_svc',
3155   },
3156
3157   {
3158     'key'         => 'selfservice-password_reset_verification',
3159     'section'     => 'self-service',
3160     'description' => 'If enabled, specifies the type of verification required for self-service password resets.',
3161     'type'        => 'select',
3162     'select_hash' => [ '' => 'Password reset disabled',
3163                        'email' => 'Click on a link in email',
3164                        'paymask,amount,zip' => 'Click on a link in email, and also verify with credit card (or bank account) last 4 digits, payment amount and zip code',
3165                      ],
3166   },
3167
3168   {
3169     'key'         => 'selfservice-password_reset_hours',
3170     'section'     => 'self-service',
3171     'description' => 'Numbers of hours an email password reset is valid.  Defaults to 24.',
3172     'type'        => 'text',
3173   },
3174
3175   {
3176     'key'         => 'selfservice-password_reset_msgnum',
3177     'section'     => 'self-service',
3178     'description' => 'Template to use for password reset emails.',
3179     %msg_template_options,
3180   },
3181
3182   {
3183     'key'         => 'selfservice-password_change_oldpass',
3184     'section'     => 'self-service',
3185     'description' => 'Require old password to be entered again for password changes (in addition to being logged in), at the API level.',
3186     'type'        => 'checkbox',
3187   },
3188
3189   {
3190     'key'         => 'selfservice-hide_invoices-taxclass',
3191     'section'     => 'self-service',
3192     'description' => 'Hide invoices with only this package tax class from self-service and supress sending (emailing, printing, faxing) them.  Typically set to something like "Previous balance" and used when importing legacy invoices into legacy_cust_bill.',
3193     'type'        => 'text',
3194   },
3195
3196   {
3197     'key'         => 'selfservice-recent-did-age',
3198     'section'     => 'self-service',
3199     'description' => 'If specified, defines "recent", in number of seconds, for "Download recently allocated DIDs" in self-service.',
3200     'type'        => 'text',
3201   },
3202
3203   {
3204     'key'         => 'selfservice_server-view-wholesale',
3205     'section'     => 'self-service',
3206     'description' => 'If enabled, use a wholesale package view in the self-service.',
3207     'type'        => 'checkbox',
3208   },
3209
3210   {
3211     'key'         => 'selfservice-agent_signup',
3212     'section'     => 'self-service',
3213     'description' => 'Allow agent signup via self-service.',
3214     'type'        => 'checkbox',
3215   },
3216
3217   {
3218     'key'         => 'selfservice-agent_signup-agent_type',
3219     'section'     => 'self-service',
3220     'description' => 'Agent type when allowing agent signup via self-service.',
3221     'type'        => 'select-sub',
3222     'options_sub' => sub { require FS::Record;
3223                            require FS::agent_type;
3224                            map { $_->typenum => $_->atype }
3225                                FS::Record::qsearch('agent_type', {} ); # disabled=>'' } );
3226                          },
3227     'option_sub'  => sub { require FS::Record;
3228                            require FS::agent_type;
3229                            my $agent_type = FS::Record::qsearchs(
3230                              'agent_type', { 'typenum'=>shift }
3231                            );
3232                            $agent_type ? $agent_type->atype : '';
3233                          },
3234   },
3235
3236   {
3237     'key'         => 'selfservice-agent_login',
3238     'section'     => 'self-service',
3239     'description' => 'Allow agent login via self-service.',
3240     'type'        => 'checkbox',
3241   },
3242
3243   {
3244     'key'         => 'selfservice-self_suspend_reason',
3245     'section'     => 'self-service',
3246     'description' => 'Suspend reason when customers suspend their own packages. Set to nothing to disallow self-suspension.',
3247     'type'        => 'select-sub',
3248     #false laziness w/api_credit_reason
3249     'options_sub' => sub { require FS::Record;
3250                            require FS::reason;
3251                            my $type = qsearchs('reason_type',
3252                              { class => 'S' })
3253                               or return ();
3254                            map { $_->reasonnum => $_->reason }
3255                                FS::Record::qsearch('reason',
3256                                  { reason_type => $type->typenum }
3257                                );
3258                          },
3259     'option_sub'  => sub { require FS::Record;
3260                            require FS::reason;
3261                            my $reason = FS::Record::qsearchs(
3262                              'reason', { 'reasonnum' => shift }
3263                            );
3264                            $reason ? $reason->reason : '';
3265                          },
3266
3267     'per_agent'   => 1,
3268   },
3269
3270   {
3271     'key'         => 'card_refund-days',
3272     'section'     => 'billing',
3273     'description' => 'After a payment, the number of days a refund link will be available for that payment.  Defaults to 120.',
3274     'type'        => 'text',
3275   },
3276
3277   {
3278     'key'         => 'agent-showpasswords',
3279     'section'     => '',
3280     'description' => 'Display unencrypted user passwords in the agent (reseller) interface',
3281     'type'        => 'checkbox',
3282   },
3283
3284   {
3285     'key'         => 'global_unique-username',
3286     'section'     => 'username',
3287     '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.',
3288     'type'        => 'select',
3289     'select_enum' => [ 'none', 'username', 'username@domain', 'disabled' ],
3290   },
3291
3292   {
3293     'key'         => 'global_unique-phonenum',
3294     'section'     => '',
3295     '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.',
3296     'type'        => 'select',
3297     'select_enum' => [ 'none', 'countrycode+phonenum', 'disabled' ],
3298   },
3299
3300   {
3301     'key'         => 'global_unique-pbx_title',
3302     'section'     => '',
3303     'description' => 'Global phone number uniqueness control: none (check uniqueness per exports), enabled (check across all services), or disabled (no duplicate checking).',
3304     'type'        => 'select',
3305     'select_enum' => [ 'enabled', 'disabled' ],
3306   },
3307
3308   {
3309     'key'         => 'global_unique-pbx_id',
3310     'section'     => '',
3311     'description' => 'Global PBX id uniqueness control: none (check uniqueness per exports), enabled (check across all services), or disabled (no duplicate checking).',
3312     'type'        => 'select',
3313     'select_enum' => [ 'enabled', 'disabled' ],
3314   },
3315
3316   {
3317     'key'         => 'svc_external-skip_manual',
3318     'section'     => 'UI',
3319     '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).',
3320     'type'        => 'checkbox',
3321   },
3322
3323   {
3324     'key'         => 'svc_external-display_type',
3325     'section'     => 'UI',
3326     'description' => 'Select a specific svc_external type to enable some UI changes specific to that type (i.e. artera_turbo).',
3327     'type'        => 'select',
3328     'select_enum' => [ 'generic', 'artera_turbo', ],
3329   },
3330
3331   {
3332     'key'         => 'ticket_system',
3333     'section'     => 'ticketing',
3334     '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:3:Documentation:RT_Installation">integrated ticketing installation instructions</a>).   <b>RT_External</b> accesses an external RT installation in a separate database (local or remote).',
3335     'type'        => 'select',
3336     #'select_enum' => [ '', qw(RT_Internal RT_Libs RT_External) ],
3337     'select_enum' => [ '', qw(RT_Internal RT_External) ],
3338   },
3339
3340   {
3341     'key'         => 'network_monitoring_system',
3342     'section'     => 'network_monitoring',
3343     '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:3:Documentation:Torrus_Installation">integrated networking monitoring system installation instructions</a>).',
3344     'type'        => 'select',
3345     'select_enum' => [ '', qw(Torrus_Internal) ],
3346   },
3347
3348   {
3349     'key'         => 'nms-auto_add-svc_ips',
3350     'section'     => 'network_monitoring',
3351     'description' => 'Automatically add (and remove) IP addresses from these service tables to the network monitoring system.',
3352     'type'        => 'selectmultiple',
3353     'select_enum' => [ 'svc_acct', 'svc_broadband', 'svc_dsl' ],
3354   },
3355
3356   {
3357     'key'         => 'nms-auto_add-community',
3358     'section'     => 'network_monitoring',
3359     'description' => 'SNMP community string to use when automatically adding IP addresses from these services to the network monitoring system.',
3360     'type'        => 'text',
3361   },
3362
3363   {
3364     'key'         => 'ticket_system-default_queueid',
3365     'section'     => 'ticketing',
3366     'description' => 'Default queue used when creating new customer tickets.',
3367     'type'        => 'select-sub',
3368     'options_sub' => sub {
3369                            my $conf = new FS::Conf;
3370                            if ( $conf->config('ticket_system') ) {
3371                              eval "use FS::TicketSystem;";
3372                              die $@ if $@;
3373                              FS::TicketSystem->queues();
3374                            } else {
3375                              ();
3376                            }
3377                          },
3378     'option_sub'  => sub {
3379                            my $conf = new FS::Conf;
3380                            if ( $conf->config('ticket_system') ) {
3381                              eval "use FS::TicketSystem;";
3382                              die $@ if $@;
3383                              FS::TicketSystem->queue(shift);
3384                            } else {
3385                              '';
3386                            }
3387                          },
3388   },
3389
3390   {
3391     'key'         => 'ticket_system-force_default_queueid',
3392     'section'     => 'ticketing',
3393     'description' => 'Disallow queue selection when creating new tickets from customer view.',
3394     'type'        => 'checkbox',
3395   },
3396
3397   {
3398     'key'         => 'ticket_system-selfservice_queueid',
3399     'section'     => 'ticketing',
3400     'description' => 'Queue used when creating new customer tickets from self-service.  Defautls to ticket_system-default_queueid if not specified.',
3401     #false laziness w/above
3402     'type'        => 'select-sub',
3403     'options_sub' => sub {
3404                            my $conf = new FS::Conf;
3405                            if ( $conf->config('ticket_system') ) {
3406                              eval "use FS::TicketSystem;";
3407                              die $@ if $@;
3408                              FS::TicketSystem->queues();
3409                            } else {
3410                              ();
3411                            }
3412                          },
3413     'option_sub'  => sub {
3414                            my $conf = new FS::Conf;
3415                            if ( $conf->config('ticket_system') ) {
3416                              eval "use FS::TicketSystem;";
3417                              die $@ if $@;
3418                              FS::TicketSystem->queue(shift);
3419                            } else {
3420                              '';
3421                            }
3422                          },
3423   },
3424
3425   {
3426     'key'         => 'ticket_system-requestor',
3427     'section'     => 'ticketing',
3428     'description' => 'Email address to use as the requestor for new tickets.  If blank, the customer\'s invoicing address(es) will be used.',
3429     'type'        => 'text',
3430   },
3431
3432   {
3433     'key'         => 'ticket_system-priority_reverse',
3434     'section'     => 'ticketing',
3435     '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.',
3436     'type'        => 'checkbox',
3437   },
3438
3439   {
3440     'key'         => 'ticket_system-custom_priority_field',
3441     'section'     => 'ticketing',
3442     'description' => 'Custom field from the ticketing system to use as a custom priority classification.',
3443     'type'        => 'text',
3444   },
3445
3446   {
3447     'key'         => 'ticket_system-custom_priority_field-values',
3448     'section'     => 'ticketing',
3449     'description' => 'Values for the custom field from the ticketing system to break down and sort customer ticket lists.',
3450     'type'        => 'textarea',
3451   },
3452
3453   {
3454     'key'         => 'ticket_system-custom_priority_field_queue',
3455     'section'     => 'ticketing',
3456     'description' => 'Ticketing system queue in which the custom field specified in ticket_system-custom_priority_field is located.',
3457     'type'        => 'text',
3458   },
3459
3460   {
3461     'key'         => 'ticket_system-selfservice_priority_field',
3462     'section'     => 'ticketing',
3463     'description' => 'Custom field from the ticket system to use as a customer-managed priority field.',
3464     'type'        => 'text',
3465   },
3466
3467   {
3468     'key'         => 'ticket_system-selfservice_edit_subject',
3469     'section'     => 'ticketing',
3470     'description' => 'Allow customers to edit ticket subjects through selfservice.',
3471     'type'        => 'checkbox',
3472   },
3473
3474   {
3475     'key'         => 'ticket_system-appointment-queueid',
3476     'section'     => 'ticketing',
3477     'description' => 'Ticketing queue to use for appointments.',
3478     #false laziness w/above
3479     'type'        => 'select-sub',
3480     'options_sub' => sub {
3481                            my $conf = new FS::Conf;
3482                            if ( $conf->config('ticket_system') ) {
3483                              eval "use FS::TicketSystem;";
3484                              die $@ if $@;
3485                              FS::TicketSystem->queues();
3486                            } else {
3487                              ();
3488                            }
3489                          },
3490     'option_sub'  => sub {
3491                            my $conf = new FS::Conf;
3492                            if ( $conf->config('ticket_system') ) {
3493                              eval "use FS::TicketSystem;";
3494                              die $@ if $@;
3495                              FS::TicketSystem->queue(shift);
3496                            } else {
3497                              '';
3498                            }
3499                          },
3500   },
3501
3502   {
3503     'key'         => 'ticket_system-appointment-custom_field',
3504     'section'     => 'ticketing',
3505     'description' => 'Ticketing custom field to use as an appointment classification.',
3506     'type'        => 'text',
3507   },
3508
3509   {
3510     'key'         => 'ticket_system-escalation',
3511     'section'     => 'ticketing',
3512     'description' => 'Enable priority escalation of tickets as part of daily batch processing.',
3513     'type'        => 'checkbox',
3514   },
3515
3516   {
3517     'key'         => 'ticket_system-rt_external_datasrc',
3518     'section'     => 'ticketing',
3519     '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>',
3520     'type'        => 'text',
3521
3522   },
3523
3524   {
3525     'key'         => 'ticket_system-rt_external_url',
3526     'section'     => 'ticketing',
3527     'description' => 'With external RT integration, the URL for the external RT installation, for example, <code>https://rt.example.com/rt</code>',
3528     'type'        => 'text',
3529   },
3530
3531   {
3532     'key'         => 'company_name',
3533     'section'     => 'required',
3534     'description' => 'Your company name',
3535     'type'        => 'text',
3536     'per_agent'   => 1, #XXX just FS/FS/ClientAPI/Signup.pm
3537   },
3538
3539   {
3540     'key'         => 'company_url',
3541     'section'     => 'UI',
3542     'description' => 'Your company URL',
3543     'type'        => 'text',
3544     'per_agent'   => 1,
3545   },
3546
3547   {
3548     'key'         => 'company_address',
3549     'section'     => 'required',
3550     'description' => 'Your company address',
3551     'type'        => 'textarea',
3552     'per_agent'   => 1,
3553   },
3554
3555   {
3556     'key'         => 'company_phonenum',
3557     'section'     => 'notification',
3558     'description' => 'Your company phone number',
3559     'type'        => 'text',
3560     'per_agent'   => 1,
3561   },
3562
3563   {
3564     'key'         => 'echeck-void',
3565     'section'     => 'deprecated',
3566     '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',
3567     'type'        => 'checkbox',
3568   },
3569
3570   {
3571     'key'         => 'cc-void',
3572     'section'     => 'deprecated',
3573     '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',
3574     'type'        => 'checkbox',
3575   },
3576
3577   {
3578     'key'         => 'unvoid',
3579     'section'     => 'deprecated',
3580     'description' => '<B>DEPRECATED</B>, now controlled by ACLs.  Used to enable unvoiding of voided payments',
3581     'type'        => 'checkbox',
3582   },
3583
3584   {
3585     'key'         => 'address1-search',
3586     'section'     => 'UI',
3587     '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.',
3588     'type'        => 'checkbox',
3589   },
3590
3591   {
3592     'key'         => 'address2-search',
3593     'section'     => 'UI',
3594     'description' => 'Enable a "Unit" search box which searches the second address field.  Useful for multi-tenant applications.  See also: cust_main-require_address2',
3595     'type'        => 'checkbox',
3596   },
3597
3598   {
3599     'key'         => 'cust_main-require_address2',
3600     'section'     => 'UI',
3601     'description' => 'Second address field is required.  Also enables "Unit" labeling of address2 on customer view and edit pages.  Useful for multi-tenant applications.  See also: address2-search', # service address only part not working in the modern world, see #41184  (on service address only, if billing and service addresses differ)
3602     'type'        => 'checkbox',
3603   },
3604
3605   {
3606     'key'         => 'agent-ship_address',
3607     'section'     => '',
3608     '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.",
3609     'type'        => 'checkbox',
3610     'per_agent'   => 1,
3611   },
3612
3613   { 'key'         => 'referral_credit',
3614     'section'     => 'deprecated',
3615     '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.",
3616     'type'        => 'checkbox',
3617   },
3618
3619   { 'key'         => 'selfservice_server-cache_module',
3620     'section'     => 'self-service',
3621     '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.',
3622     'type'        => 'select',
3623     'select_enum' => [ 'Cache::SharedMemoryCache', 'Cache::FileCache', ], # '_Database' ],
3624   },
3625
3626   {
3627     'key'         => 'hylafax',
3628     'section'     => 'billing',
3629     '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).',
3630     'type'        => [qw( checkbox textarea )],
3631   },
3632
3633   {
3634     'key'         => 'cust_bill-ftpformat',
3635     'section'     => 'invoicing',
3636     'description' => 'Enable FTP of raw invoice data - format.',
3637     'type'        => 'select',
3638     'options'     => [ spool_formats() ],
3639   },
3640
3641   {
3642     'key'         => 'cust_bill-ftpserver',
3643     'section'     => 'invoicing',
3644     'description' => 'Enable FTP of raw invoice data - server.',
3645     'type'        => 'text',
3646   },
3647
3648   {
3649     'key'         => 'cust_bill-ftpusername',
3650     'section'     => 'invoicing',
3651     'description' => 'Enable FTP of raw invoice data - server.',
3652     'type'        => 'text',
3653   },
3654
3655   {
3656     'key'         => 'cust_bill-ftppassword',
3657     'section'     => 'invoicing',
3658     'description' => 'Enable FTP of raw invoice data - server.',
3659     'type'        => 'text',
3660   },
3661
3662   {
3663     'key'         => 'cust_bill-ftpdir',
3664     'section'     => 'invoicing',
3665     'description' => 'Enable FTP of raw invoice data - server.',
3666     'type'        => 'text',
3667   },
3668
3669   {
3670     'key'         => 'cust_bill-spoolformat',
3671     'section'     => 'invoicing',
3672     'description' => 'Enable spooling of raw invoice data - format.',
3673     'type'        => 'select',
3674     'options'     => [ spool_formats() ],
3675   },
3676
3677   {
3678     'key'         => 'cust_bill-spoolagent',
3679     'section'     => 'invoicing',
3680     'description' => 'Enable per-agent spooling of raw invoice data.',
3681     'type'        => 'checkbox',
3682   },
3683
3684   {
3685     'key'         => 'bridgestone-batch_counter',
3686     'section'     => '',
3687     'description' => 'Batch counter for spool files.  Increments every time a spool file is uploaded.',
3688     'type'        => 'text',
3689     'per_agent'   => 1,
3690   },
3691
3692   {
3693     'key'         => 'bridgestone-prefix',
3694     'section'     => '',
3695     'description' => 'Agent identifier for uploading to BABT printing service.',
3696     'type'        => 'text',
3697     'per_agent'   => 1,
3698   },
3699
3700   {
3701     'key'         => 'bridgestone-confirm_template',
3702     'section'     => '',
3703     'description' => 'Confirmation email template for uploading to BABT service.  Text::Template format, with variables "$zipfile" (name of the zipped file), "$seq" (sequence number), "$prefix" (user ID string), and "$rows" (number of records in the file).  Should include Subject: and To: headers, separated from the rest of the message by a blank line.',
3704     # this could use a true message template, but it's hard to see how that
3705     # would make the world a better place
3706     'type'        => 'textarea',
3707     'per_agent'   => 1,
3708   },
3709
3710   {
3711     'key'         => 'ics-confirm_template',
3712     'section'     => '',
3713     'description' => 'Confirmation email template for uploading to ICS invoice printing.  Text::Template format, with variables "%count" and "%sum".',
3714     'type'        => 'textarea',
3715     'per_agent'   => 1,
3716   },
3717
3718   {
3719     'key'         => 'svc_acct-usage_suspend',
3720     'section'     => 'billing',
3721     '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.',
3722     'type'        => 'checkbox',
3723   },
3724
3725   {
3726     'key'         => 'svc_acct-usage_unsuspend',
3727     'section'     => 'billing',
3728     '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.',
3729     'type'        => 'checkbox',
3730   },
3731
3732   {
3733     'key'         => 'svc_acct-usage_threshold',
3734     'section'     => 'billing',
3735     '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.',
3736     'type'        => 'text',
3737   },
3738
3739   {
3740     'key'         => 'overlimit_groups',
3741     'section'     => '',
3742     'description' => 'RADIUS group(s) to assign to svc_acct which has exceeded its bandwidth or time limit.',
3743     'type'        => 'select-sub',
3744     'per_agent'   => 1,
3745     'multiple'    => 1,
3746     'options_sub' => sub { require FS::Record;
3747                            require FS::radius_group;
3748                            map { $_->groupnum => $_->long_description }
3749                                FS::Record::qsearch('radius_group', {} );
3750                          },
3751     'option_sub'  => sub { require FS::Record;
3752                            require FS::radius_group;
3753                            my $radius_group = FS::Record::qsearchs(
3754                              'radius_group', { 'groupnum' => shift }
3755                            );
3756                $radius_group ? $radius_group->long_description : '';
3757                          },
3758   },
3759
3760   {
3761     'key'         => 'cust-fields',
3762     'section'     => 'UI',
3763     'description' => 'Which customer fields to display on reports by default',
3764     'type'        => 'select',
3765     'select_hash' => [ FS::ConfDefaults->cust_fields_avail() ],
3766   },
3767
3768   {
3769     'key'         => 'cust_location-label_prefix',
3770     'section'     => 'UI',
3771     'description' => 'Optional "site ID" to show in the location label',
3772     'type'        => 'select',
3773     'select_hash' => [ '' => '',
3774                        'CoStAg'    => 'CoStAgXXXXX (country, state, agent name, locationnum)',
3775                        '_location' => 'Manually defined per location',
3776                       ],
3777   },
3778
3779   {
3780     'key'         => 'cust_pkg-display_times',
3781     'section'     => 'UI',
3782     'description' => 'Display full timestamps (not just dates) for customer packages.  Useful if you are doing real-time things like hourly prepaid.',
3783     'type'        => 'checkbox',
3784   },
3785
3786   {
3787     'key'         => 'cust_pkg-always_show_location',
3788     'section'     => 'UI',
3789     'description' => "Always display package locations, even when they're all the default service address.",
3790     'type'        => 'checkbox',
3791   },
3792
3793   {
3794     'key'         => 'cust_pkg-group_by_location',
3795     'section'     => 'UI',
3796     'description' => "Group packages by location.",
3797     'type'        => 'checkbox',
3798   },
3799
3800   {
3801     'key'         => 'cust_pkg-large_pkg_size',
3802     'section'     => 'UI',
3803     'description' => "In customer view, summarize packages with more than this many services.  Set to zero to never summarize packages.",
3804     'type'        => 'text',
3805   },
3806
3807   {
3808     'key'         => 'cust_pkg-hide_discontinued-part_svc',
3809     'section'     => 'UI',
3810     'description' => "In customer view, hide provisioned services which are no longer available in the package definition.  Not normally used except for very specific situations as it hides still-provisioned services.",
3811     'type'        => 'checkbox',
3812   },
3813
3814   {
3815     'key'         => 'part_pkg-show_fcc_options',
3816     'section'     => 'UI',
3817     'description' => "Show fields on package definitions for FCC Form 477 classification",
3818     'type'        => 'checkbox',
3819   },
3820
3821   {
3822     'key'         => 'svc_acct-edit_uid',
3823     'section'     => 'shell',
3824     'description' => 'Allow UID editing.',
3825     'type'        => 'checkbox',
3826   },
3827
3828   {
3829     'key'         => 'svc_acct-edit_gid',
3830     'section'     => 'shell',
3831     'description' => 'Allow GID editing.',
3832     'type'        => 'checkbox',
3833   },
3834
3835   {
3836     'key'         => 'svc_acct-no_edit_username',
3837     'section'     => 'shell',
3838     'description' => 'Disallow username editing.',
3839     'type'        => 'checkbox',
3840   },
3841
3842   {
3843     'key'         => 'zone-underscore',
3844     'section'     => 'BIND',
3845     'description' => 'Allow underscores in zone names.  As underscores are illegal characters in zone names, this option is not recommended.',
3846     'type'        => 'checkbox',
3847   },
3848
3849   {
3850     'key'         => 'echeck-nonus',
3851     'section'     => 'deprecated',
3852     'description' => 'Deprecated; see echeck-country instead.  Used to disable ABA-format account checking for Electronic Check payment info',
3853     'type'        => 'checkbox',
3854   },
3855
3856   {
3857     'key'         => 'echeck-country',
3858     'section'     => 'billing',
3859     'description' => 'Format electronic check information for the specified country.',
3860     'type'        => 'select',
3861     'select_hash' => [ 'US' => 'United States',
3862                        'CA' => 'Canada (enables branch)',
3863                        'XX' => 'Other',
3864                      ],
3865   },
3866
3867   {
3868     'key'         => 'voip-cust_accountcode_cdr',
3869     'section'     => 'telephony',
3870     'description' => 'Enable the per-customer option for CDR breakdown by accountcode.',
3871     'type'        => 'checkbox',
3872   },
3873
3874   {
3875     'key'         => 'voip-cust_cdr_spools',
3876     'section'     => 'telephony',
3877     'description' => 'Enable the per-customer option for individual CDR spools.',
3878     'type'        => 'checkbox',
3879   },
3880
3881   {
3882     'key'         => 'voip-cust_cdr_squelch',
3883     'section'     => 'telephony',
3884     'description' => 'Enable the per-customer option for not printing CDR on invoices.',
3885     'type'        => 'checkbox',
3886   },
3887
3888   {
3889     'key'         => 'voip-cdr_email',
3890     'section'     => 'telephony',
3891     'description' => 'Include the call details inline on emailed invoices (and HTML invoices viewed in the backend), even if the customer is configured for not printing them on the invoices.  Useful for including these details in electronic delivery but omitting them when printing.',
3892     'type'        => 'checkbox',
3893   },
3894
3895   {
3896     'key'         => 'voip-cust_email_csv_cdr',
3897     'section'     => 'deprecated',
3898     'description' => 'Deprecated, see voip-cdr_email_attach instead.  Used to enable the per-customer option for including CDR information as a CSV attachment on emailed invoices.',
3899     'type'        => 'checkbox',
3900   },
3901
3902   {
3903     'key'         => 'voip-cdr_email_attach',
3904     'section'     => 'telephony',
3905     'description' => 'Enable the per-customer option for including CDR information as an attachment on emailed invoices.',
3906     'type'        => 'select',
3907     'select_hash' => [ ''    => 'Disabled',
3908                        'csv' => 'Text (CSV) attachment',
3909                        'zip' => 'Zip attachment',
3910                      ],
3911   },
3912
3913   {
3914     'key'         => 'cgp_rule-domain_templates',
3915     'section'     => '',
3916     'description' => 'Communigate Pro rule templates for domains, one per line, "svcnum Name"',
3917     'type'        => 'textarea',
3918   },
3919
3920   {
3921     'key'         => 'svc_forward-no_srcsvc',
3922     'section'     => '',
3923     '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.",
3924     'type'        => 'checkbox',
3925   },
3926
3927   {
3928     'key'         => 'svc_forward-arbitrary_dst',
3929     'section'     => '',
3930     '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.",
3931     'type'        => 'checkbox',
3932   },
3933
3934   {
3935     'key'         => 'tax-ship_address',
3936     'section'     => 'billing',
3937     'description' => 'By default, tax calculations are done based on the billing address.  Enable this switch to calculate tax based on the shipping address instead.',
3938     'type'        => 'checkbox',
3939   }
3940 ,
3941   {
3942     'key'         => 'tax-pkg_address',
3943     'section'     => 'billing',
3944     '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).',
3945     'type'        => 'checkbox',
3946   },
3947
3948   {
3949     'key'         => 'invoice-ship_address',
3950     'section'     => 'invoicing',
3951     'description' => 'Include the shipping address on invoices.',
3952     'type'        => 'checkbox',
3953   },
3954
3955   {
3956     'key'         => 'invoice-all_pkg_addresses',
3957     'section'     => 'invoicing',
3958     'description' => 'Show all package addresses on invoices, even the default.',
3959     'type'        => 'checkbox',
3960   },
3961
3962   {
3963     'key'         => 'invoice-unitprice',
3964     'section'     => 'invoicing',
3965     'description' => 'Enable unit pricing on invoices and quantities on packages.',
3966     'type'        => 'checkbox',
3967   },
3968
3969   {
3970     'key'         => 'invoice-smallernotes',
3971     'section'     => 'invoicing',
3972     'description' => 'Display the notes section in a smaller font on invoices.',
3973     'type'        => 'checkbox',
3974   },
3975
3976   {
3977     'key'         => 'invoice-smallerfooter',
3978     'section'     => 'invoicing',
3979     'description' => 'Display footers in a smaller font on invoices.',
3980     'type'        => 'checkbox',
3981   },
3982
3983   {
3984     'key'         => 'postal_invoice-fee_pkgpart',
3985     'section'     => 'billing',
3986     'description' => 'This allows selection of a package to insert on invoices for customers with postal invoices selected.',
3987     'type'        => 'select-part_pkg',
3988     'per_agent'   => 1,
3989   },
3990
3991   {
3992     'key'         => 'postal_invoice-recurring_only',
3993     'section'     => 'billing',
3994     'description' => 'The postal invoice fee is omitted on invoices without recurring charges when this is set.',
3995     'type'        => 'checkbox',
3996   },
3997
3998   {
3999     'key'         => 'batch-enable',
4000     'section'     => 'deprecated', #make sure batch-enable_payby is set for
4001                                    #everyone before removing
4002     'description' => 'Enable credit card and/or ACH batching - leave disabled for real-time installations.',
4003     'type'        => 'checkbox',
4004   },
4005
4006   {
4007     'key'         => 'batch-enable_payby',
4008     'section'     => 'billing',
4009     'description' => 'Enable batch processing for the specified payment types.',
4010     'type'        => 'selectmultiple',
4011     'select_enum' => [qw( CARD CHEK )],
4012   },
4013
4014   {
4015     'key'         => 'realtime-disable_payby',
4016     'section'     => 'billing',
4017     'description' => 'Disable realtime processing for the specified payment types.',
4018     'type'        => 'selectmultiple',
4019     'select_enum' => [qw( CARD CHEK )],
4020   },
4021
4022   {
4023     'key'         => 'batch-default_format',
4024     'section'     => 'billing',
4025     'description' => 'Default format for batches.',
4026     'type'        => 'select',
4027     'select_enum' => [ 'NACHA', 'csv-td_canada_trust-merchant_pc_batch',
4028                        'csv-chase_canada-E-xactBatch', 'BoM', 'PAP',
4029                        'paymentech', 'ach-spiritone', 'RBC', 'CIBC',
4030                     ]
4031   },
4032
4033   { 'key'         => 'batch-gateway-CARD',
4034     'section'     => 'billing',
4035     'description' => 'Business::BatchPayment gateway for credit card batches.',
4036     %batch_gateway_options,
4037   },
4038
4039   { 'key'         => 'batch-gateway-CHEK',
4040     'section'     => 'billing',
4041     'description' => 'Business::BatchPayment gateway for check batches.',
4042     %batch_gateway_options,
4043   },
4044
4045   {
4046     'key'         => 'batch-reconsider',
4047     'section'     => 'billing',
4048     'description' => 'Allow imported batch results to change the status of payments from previous imports.  Enable this only if your gateway is known to send both positive and negative results for the same batch.',
4049     'type'        => 'checkbox',
4050   },
4051
4052   {
4053     'key'         => 'batch-auto_resolve_days',
4054     'section'     => 'billing',
4055     'description' => 'Automatically resolve payment batches this many days after they were first downloaded.',
4056     'type'        => 'text',
4057   },
4058
4059   {
4060     'key'         => 'batch-auto_resolve_status',
4061     'section'     => 'billing',
4062     'description' => 'When automatically resolving payment batches, take this action for payments of unknown status.',
4063     'type'        => 'select',
4064     'select_enum' => [ 'approve', 'decline' ],
4065   },
4066
4067   {
4068     'key'         => 'batch-errors_to',
4069     'section'     => 'billing',
4070     'description' => 'Email errors when processing batches to this address.  If unspecified, batch processing will stop immediately on error.',
4071     'type'        => 'text',
4072   },
4073
4074   #lists could be auto-generated from pay_batch info
4075   {
4076     'key'         => 'batch-fixed_format-CARD',
4077     'section'     => 'billing',
4078     'description' => 'Fixed (unchangeable) format for credit card batches.',
4079     'type'        => 'select',
4080     'select_enum' => [ 'csv-td_canada_trust-merchant_pc_batch', 'BoM', 'PAP' ,
4081                        'csv-chase_canada-E-xactBatch', 'paymentech' ]
4082   },
4083
4084   {
4085     'key'         => 'batch-fixed_format-CHEK',
4086     'section'     => 'billing',
4087     'description' => 'Fixed (unchangeable) format for electronic check batches.',
4088     'type'        => 'select',
4089     'select_enum' => [ 'NACHA', 'csv-td_canada_trust-merchant_pc_batch', 'BoM',
4090                        'PAP', 'paymentech', 'ach-spiritone', 'RBC',
4091                        'td_eft1464', 'eft_canada', 'CIBC'
4092                      ]
4093   },
4094
4095   {
4096     'key'         => 'batch-increment_expiration',
4097     'section'     => 'billing',
4098     'description' => 'Increment expiration date years in batches until cards are current.  Make sure this is acceptable to your batching provider before enabling.',
4099     'type'        => 'checkbox'
4100   },
4101
4102   {
4103     'key'         => 'batchconfig-BoM',
4104     'section'     => 'billing',
4105     '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',
4106     'type'        => 'textarea',
4107   },
4108
4109 {
4110     'key'         => 'batchconfig-CIBC',
4111     'section'     => 'billing',
4112     'description' => 'Configuration for Canadian Imperial Bank of Commerce, six lines: 1. Origin ID, 2. Datacenter, 3. Typecode, 4. Short name, 5. Bank, 6. Bank account',
4113     'type'        => 'textarea',
4114   },
4115
4116   {
4117     'key'         => 'batchconfig-PAP',
4118     'section'     => 'billing',
4119     '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',
4120     'type'        => 'textarea',
4121   },
4122
4123   {
4124     'key'         => 'batchconfig-csv-chase_canada-E-xactBatch',
4125     'section'     => 'billing',
4126     'description' => 'Gateway ID for Chase Canada E-xact batching',
4127     'type'        => 'text',
4128   },
4129
4130   {
4131     'key'         => 'batchconfig-paymentech',
4132     'section'     => 'billing',
4133     'description' => 'Configuration for Chase Paymentech batching, six lines: 1. BIN, 2. Terminal ID, 3. Merchant ID, 4. Username, 5. Password (for batch uploads), 6. Flag to send recurring indicator.',
4134     'type'        => 'textarea',
4135   },
4136
4137   {
4138     'key'         => 'batchconfig-RBC',
4139     'section'     => 'billing',
4140     'description' => 'Configuration for Royal Bank of Canada PDS batching, five lines: 1. Client number, 2. Short name, 3. Long name, 4. Transaction code 5. (optional) set to TEST to turn on test mode.',
4141     'type'        => 'textarea',
4142   },
4143
4144   {
4145     'key'         => 'batchconfig-RBC-login',
4146     'section'     => 'billing',
4147     'description' => 'FTPS login for uploading Royal Bank of Canada batches. Two lines: 1. username, 2. password. If not supplied, batches can still be created but not automatically uploaded.',
4148     'type'        => 'textarea',
4149   },
4150
4151   {
4152     'key'         => 'batchconfig-td_eft1464',
4153     'section'     => 'billing',
4154     '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.',
4155     'type'        => 'textarea',
4156   },
4157
4158   {
4159     'key'         => 'batchconfig-eft_canada',
4160     'section'     => 'billing',
4161     'description' => 'Configuration for EFT Canada batching, five lines: 1. SFTP username, 2. SFTP password, 3. Business transaction code, 4. Personal transaction code, 5. Number of days to delay process date.  If you are using separate per-agent batches (batch-spoolagent), you must set this option separately for each agent, as the global setting will be ignored.',
4162     'type'        => 'textarea',
4163     'per_agent'   => 1,
4164   },
4165
4166   {
4167     'key'         => 'batchconfig-nacha-destination',
4168     'section'     => 'billing',
4169     'description' => 'Configuration for NACHA batching, Destination (9 digit transit routing number).',
4170     'type'        => 'text',
4171   },
4172
4173   {
4174     'key'         => 'batchconfig-nacha-destination_name',
4175     'section'     => 'billing',
4176     'description' => 'Configuration for NACHA batching, Destination (Bank Name, up to 23 characters).',
4177     'type'        => 'text',
4178   },
4179
4180   {
4181     'key'         => 'batchconfig-nacha-origin',
4182     'section'     => 'billing',
4183     'description' => 'Configuration for NACHA batching, Origin (your 10-digit company number, IRS tax ID recommended).',
4184     'type'        => 'text',
4185   },
4186
4187   {
4188     'key'         => 'batchconfig-nacha-origin_name',
4189     'section'     => 'billing',
4190     'description' => 'Configuration for NACHA batching, Origin name (defaults to company name, but sometimes bank name is needed instead.)',
4191     'type'        => 'text',
4192   },
4193
4194   {
4195     'key'         => 'batch-manual_approval',
4196     'section'     => 'billing',
4197     'description' => 'Allow manual batch closure, which will approve all payments that do not yet have a status.  This is not advised unless needed for specific payment processors that provide a report of rejected rather than approved payments.',
4198     'type'        => 'checkbox',
4199   },
4200
4201   {
4202     'key'         => 'batch-spoolagent',
4203     'section'     => 'billing',
4204     'description' => 'Store payment batches per-agent.',
4205     'type'        => 'checkbox',
4206   },
4207
4208   {
4209     'key'         => 'payment_history-years',
4210     'section'     => 'UI',
4211     'description' => 'Number of years of payment history to show by default.  Currently defaults to 2.',
4212     'type'        => 'text',
4213   },
4214
4215   {
4216     'key'         => 'change_history-years',
4217     'section'     => 'UI',
4218     'description' => 'Number of years of change history to show by default.  Currently defaults to 0.5.',
4219     'type'        => 'text',
4220   },
4221
4222   {
4223     'key'         => 'cust_main-packages-years',
4224     'section'     => 'UI',
4225     'description' => 'Number of years to show old (cancelled and one-time charge) packages by default.  Currently defaults to 2.',
4226     'type'        => 'text',
4227   },
4228
4229   {
4230     'key'         => 'cust_main-use_comments',
4231     'section'     => 'UI',
4232     'description' => 'Display free form comments on the customer edit screen.  Useful as a scratch pad.',
4233     'type'        => 'checkbox',
4234   },
4235
4236   {
4237     'key'         => 'cust_main-disable_notes',
4238     'section'     => 'UI',
4239     'description' => 'Disable new style customer notes - timestamped and user identified customer notes.  Useful in tracking who did what.',
4240     'type'        => 'checkbox',
4241   },
4242
4243   {
4244     'key'         => 'cust_main_note-display_times',
4245     'section'     => 'UI',
4246     'description' => 'Display full timestamps (not just dates) for customer notes.',
4247     'type'        => 'checkbox',
4248   },
4249
4250   {
4251     'key'         => 'cust_main_note-require_class',
4252     'section'     => 'UI',
4253     'description' => 'Require customer note classes for customer notes',
4254     'type'        => 'checkbox',
4255   },
4256
4257   {
4258     'key'         => 'cust_main-ticket_statuses',
4259     'section'     => 'UI',
4260     'description' => 'Show tickets with these statuses on the customer view page.',
4261     'type'        => 'selectmultiple',
4262     'select_enum' => [qw( new open stalled resolved rejected deleted )],
4263   },
4264
4265   {
4266     'key'         => 'cust_main-max_tickets',
4267     'section'     => 'UI',
4268     'description' => 'Maximum number of tickets to show on the customer view page.',
4269     'type'        => 'text',
4270   },
4271
4272   {
4273     'key'         => 'cust_main-enable_birthdate',
4274     'section'     => 'UI',
4275     'description' => 'Enable tracking of a birth date with each customer record',
4276     'type'        => 'checkbox',
4277   },
4278
4279   {
4280     'key'         => 'cust_main-enable_spouse',
4281     'section'     => 'UI',
4282     'description' => 'Enable tracking of a spouse\'s name and date of birth with each customer record',
4283     'type'        => 'checkbox',
4284   },
4285
4286   {
4287     'key'         => 'cust_main-enable_anniversary_date',
4288     'section'     => 'UI',
4289     'description' => 'Enable tracking of an anniversary date with each customer record',
4290     'type'        => 'checkbox',
4291   },
4292
4293   {
4294     'key'         => 'cust_main-enable_order_package',
4295     'section'     => 'UI',
4296     'description' => 'Display order new package on the basic tab',
4297     'type'        => 'checkbox',
4298   },
4299
4300   {
4301     'key'         => 'cust_main-edit_calling_list_exempt',
4302     'section'     => 'UI',
4303     'description' => 'Display the "calling_list_exempt" checkbox on customer edit.',
4304     'type'        => 'checkbox',
4305   },
4306
4307   {
4308     'key'         => 'support-key',
4309     'section'     => '',
4310     'description' => 'A support key enables access to commercial services delivered over the network, such as address normalization and invoice printing.',
4311     'type'        => 'text',
4312   },
4313
4314   {
4315     'key'         => 'freesideinc-webservice-svcpart',
4316     'section'     => '',
4317     'description' => 'Do not set this.',
4318     'type'        => 'text',
4319   },
4320
4321   {
4322     'key'         => 'card-types',
4323     'section'     => 'billing',
4324     'description' => 'Select one or more card types to enable only those card types.  If no card types are selected, all card types are available.',
4325     'type'        => 'selectmultiple',
4326     'select_enum' => \@card_types,
4327   },
4328
4329   {
4330     'key'         => 'disable-fuzzy',
4331     'section'     => 'UI',
4332     'description' => 'Disable fuzzy searching.  Speeds up searching for large sites, but only shows exact matches.',
4333     'type'        => 'checkbox',
4334   },
4335
4336   {
4337     'key'         => 'fuzzy-fuzziness',
4338     'section'     => 'UI',
4339     'description' => 'Set the "fuzziness" of fuzzy searching (see the String::Approx manpage for details).  Defaults to 10%',
4340     'type'        => 'text',
4341   },
4342
4343   {
4344     'key'         => 'enable_fuzzy_on_exact',
4345     'section'     => 'UI',
4346     'description' => 'Enable approximate customer searching even when an exact match is found.',
4347     'type'        => 'checkbox',
4348   },
4349
4350   { 'key'         => 'pkg_referral',
4351     'section'     => '',
4352     'description' => 'Enable package-specific advertising sources.',
4353     'type'        => 'checkbox',
4354   },
4355
4356   { 'key'         => 'pkg_referral-multiple',
4357     'section'     => '',
4358     'description' => 'In addition, allow multiple advertising sources to be associated with a single package.',
4359     'type'        => 'checkbox',
4360   },
4361
4362   {
4363     'key'         => 'dashboard-install_welcome',
4364     'section'     => 'UI',
4365     'description' => 'New install welcome screen.',
4366     'type'        => 'select',
4367     'select_enum' => [ '', 'ITSP_fsinc_hosted', ],
4368   },
4369
4370   {
4371     'key'         => 'dashboard-toplist',
4372     'section'     => 'UI',
4373     'description' => 'List of items to display on the top of the front page',
4374     'type'        => 'textarea',
4375   },
4376
4377   {
4378     'key'         => 'impending_recur_msgnum',
4379     'section'     => 'notification',
4380     'description' => 'Template to use for alerts about first-time recurring billing.',
4381     %msg_template_options,
4382   },
4383
4384   {
4385     'key'         => 'impending_recur_template',
4386     'section'     => 'deprecated',
4387     '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>',
4388 # <li><code>$payby</code> <li><code>$expdate</code> most likely only confuse
4389     'type'        => 'textarea',
4390   },
4391
4392   {
4393     'key'         => 'logo.png',
4394     'section'     => 'UI',  #'invoicing' ?
4395     'description' => 'Company logo for HTML invoices and the backoffice interface, in PNG format.  Suggested size somewhere near 92x62.',
4396     'type'        => 'image',
4397     'per_agent'   => 1, #XXX just view/logo.cgi, which is for the global
4398                         #old-style editor anyway...?
4399     'per_locale'  => 1,
4400   },
4401
4402   {
4403     'key'         => 'logo.eps',
4404     'section'     => 'invoicing',
4405     'description' => 'Company logo for printed and PDF invoices, in EPS format.',
4406     'type'        => 'image',
4407     'per_agent'   => 1, #XXX as above, kinda
4408     'per_locale'  => 1,
4409   },
4410
4411   {
4412     'key'         => 'selfservice-ignore_quantity',
4413     'section'     => 'self-service',
4414     'description' => 'Ignores service quantity restrictions in self-service context.  Strongly not recommended - just set your quantities correctly in the first place.',
4415     'type'        => 'checkbox',
4416   },
4417
4418   {
4419     'key'         => 'selfservice-session_timeout',
4420     'section'     => 'self-service',
4421     'description' => 'Self-service session timeout.  Defaults to 1 hour.',
4422     'type'        => 'select',
4423     'select_enum' => [ '1 hour', '2 hours', '4 hours', '8 hours', '1 day', '1 week', ],
4424   },
4425
4426   {
4427     'key'         => 'password-generated-characters',
4428     'section'     => 'password',
4429     'description' => 'Set of characters to use when generating random passwords. This must contain at least one lowercase letter, uppercase letter, digit, and punctuation mark.',
4430     'type'        => 'textarea',
4431   },
4432
4433   {
4434     'key'         => 'password-no_reuse',
4435     'section'     => 'password',
4436     'description' => 'Minimum number of password changes before a password can be reused. By default, passwords can be reused without restriction.',
4437     'type'        => 'text',
4438   },
4439
4440   {
4441     'key'         => 'password-insecure',
4442     'section'     => 'password',
4443     'description' => 'Disable all password security checks and allow entry of insecure passwords.  NOT RECOMMENDED.',
4444     'type'        => 'checkbox',
4445     'per_agent'   => 1,
4446   },
4447
4448   {
4449     'key'         => 'datavolume-forcemegabytes',
4450     'section'     => 'UI',
4451     'description' => 'All data volumes are expressed in megabytes',
4452     'type'        => 'checkbox',
4453   },
4454
4455   {
4456     'key'         => 'datavolume-significantdigits',
4457     'section'     => 'UI',
4458     'description' => 'number of significant digits to use to represent data volumes',
4459     'type'        => 'text',
4460   },
4461
4462   {
4463     'key'         => 'disable_void_after',
4464     'section'     => 'billing',
4465     'description' => 'Number of seconds after which freeside won\'t attempt to VOID a payment first when performing a refund.',
4466     'type'        => 'text',
4467   },
4468
4469   {
4470     'key'         => 'disable_line_item_date_ranges',
4471     'section'     => 'billing',
4472     'description' => 'Prevent freeside from automatically generating date ranges on invoice line items.',
4473     'type'        => 'checkbox',
4474   },
4475
4476   {
4477     'key'         => 'cust_bill-line_item-date_style',
4478     'section'     => 'billing',
4479     'description' => 'Display format for line item date ranges on invoice line items.',
4480     'type'        => 'select',
4481     'select_hash' => [ ''           => 'STARTDATE-ENDDATE',
4482                        'month_of'   => 'Month of MONTHNAME',
4483                        'X_month'    => 'DATE_DESC MONTHNAME',
4484                      ],
4485     'per_agent'   => 1,
4486   },
4487
4488   {
4489     'key'         => 'cust_bill-line_item-date_style-non_monthly',
4490     'section'     => 'billing',
4491     'description' => 'If set, override cust_bill-line_item-date_style for non-monthly charges.',
4492     'type'        => 'select',
4493     'select_hash' => [ ''           => 'Default',
4494                        'start_end'  => 'STARTDATE-ENDDATE',
4495                        'month_of'   => 'Month of MONTHNAME',
4496                        'X_month'    => 'DATE_DESC MONTHNAME',
4497                      ],
4498     'per_agent'   => 1,
4499   },
4500
4501   {
4502     'key'         => 'cust_bill-line_item-date_description',
4503     'section'     => 'billing',
4504     'description' => 'Text to display for "DATE_DESC" when using cust_bill-line_item-date_style DATE_DESC MONTHNAME.',
4505     'type'        => 'text',
4506     'per_agent'   => 1,
4507   },
4508
4509   {
4510     'key'         => 'support_packages',
4511     'section'     => '',
4512     '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...
4513     'type'        => 'select-part_pkg',
4514     'multiple'    => 1,
4515   },
4516
4517   {
4518     'key'         => 'cust_main-require_phone',
4519     'section'     => '',
4520     'description' => 'Require daytime or night phone for all customer records.',
4521     'type'        => 'checkbox',
4522     'per_agent'   => 1,
4523   },
4524
4525   {
4526     'key'         => 'cust_main-require_invoicing_list_email',
4527     'section'     => '',
4528     'description' => 'Email address field is required: require at least one invoicing email address for all customer records.',
4529     'type'        => 'checkbox',
4530     'per_agent'   => 1,
4531   },
4532
4533   {
4534     'key'         => 'cust_main-require_classnum',
4535     'section'     => '',
4536     'description' => 'Customer class is required: require customer class for all customer records.',
4537     'type'        => 'checkbox',
4538   },
4539
4540   {
4541     'key'         => 'cust_main-check_unique',
4542     'section'     => '',
4543     'description' => 'Warn before creating a customer record where these fields duplicate another customer.',
4544     'type'        => 'select',
4545     'multiple'    => 1,
4546     'select_hash' => [
4547       'address' => 'Billing or service address',
4548     ],
4549   },
4550
4551   {
4552     'key'         => 'svc_acct-display_paid_time_remaining',
4553     'section'     => '',
4554     'description' => 'Show paid time remaining in addition to time remaining.',
4555     'type'        => 'checkbox',
4556   },
4557
4558   {
4559     'key'         => 'cancel_credit_type',
4560     'section'     => 'billing',
4561     'description' => 'The group to use for new, automatically generated credit reasons resulting from cancellation.',
4562     reason_type_options('R'),
4563   },
4564
4565   {
4566     'key'         => 'suspend_credit_type',
4567     'section'     => 'billing',
4568     'description' => 'The group to use for new, automatically generated credit reasons resulting from package suspension.',
4569     reason_type_options('R'),
4570   },
4571
4572   {
4573     'key'         => 'referral_credit_type',
4574     'section'     => 'deprecated',
4575     '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.',
4576     reason_type_options('R'),
4577   },
4578
4579   # was only used to negate invoices during signup when card was declined, now we just void
4580   {
4581     'key'         => 'signup_credit_type',
4582     'section'     => 'deprecated', #self-service?
4583     'description' => 'The group to use for new, automatically generated credit reasons resulting from signup and self-service declines.',
4584     reason_type_options('R'),
4585   },
4586
4587   {
4588     'key'         => 'prepayment_discounts-credit_type',
4589     'section'     => 'billing',
4590     'description' => 'Enables the offering of prepayment discounts and establishes the credit reason type.',
4591     reason_type_options('R'),
4592   },
4593
4594   {
4595     'key'         => 'cust_main-agent_custid-format',
4596     'section'     => '',
4597     'description' => 'Enables searching of various formatted values in cust_main.agent_custid',
4598     'type'        => 'select',
4599     'select_hash' => [
4600                        ''       => 'Numeric only',
4601                        '\d{7}'  => 'Numeric only, exactly 7 digits',
4602                        'ww?d+'  => 'Numeric with one or two letter prefix',
4603                        'd+-w'   => 'Numeric with a dash and one letter suffix',
4604                      ],
4605   },
4606
4607   {
4608     'key'         => 'card_masking_method',
4609     'section'     => 'UI',
4610     '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.',
4611     'type'        => 'select',
4612     'select_hash' => [
4613                        ''            => '123456xxxxxx1234',
4614                        'first6last2' => '123456xxxxxxxx12',
4615                        'first4last4' => '1234xxxxxxxx1234',
4616                        'first4last2' => '1234xxxxxxxxxx12',
4617                        'first2last4' => '12xxxxxxxxxx1234',
4618                        'first2last2' => '12xxxxxxxxxxxx12',
4619                        'first0last4' => 'xxxxxxxxxxxx1234',
4620                        'first0last2' => 'xxxxxxxxxxxxxx12',
4621                      ],
4622   },
4623
4624   {
4625     'key'         => 'disable_previous_balance',
4626     'section'     => 'invoicing',
4627     'description' => 'Show new charges only; do not list previous invoices, payments, or credits on the invoice.',
4628     'type'        => 'checkbox',
4629     'per_agent'   => 1,
4630   },
4631
4632   {
4633     'key'         => 'previous_balance-exclude_from_total',
4634     'section'     => 'invoicing',
4635     'description' => 'Show separate totals for previous invoice balance and new charges. Only meaningful when invoice_sections is false.',
4636     'type'        => 'checkbox',
4637   },
4638
4639   {
4640     'key'         => 'previous_balance-text',
4641     'section'     => 'invoicing',
4642     'description' => 'Text for the label of the total previous balance, when it is shown separately. Defaults to "Previous Balance".',
4643     'type'        => 'text',
4644     'per_locale'  => 1,
4645   },
4646
4647   {
4648     'key'         => 'previous_balance-text-total_new_charges',
4649     'section'     => 'invoicing',
4650     'description' => 'Text for the label of the total of new charges, when it is shown separately. If invoice_show_prior_due_date is enabled, the due date of current charges will be appended. Defaults to "Total New Charges".',
4651     'type'        => 'text',
4652     'per_locale'  => 1,
4653   },
4654
4655   {
4656     'key'         => 'previous_balance-section',
4657     'section'     => 'invoicing',
4658     'description' => 'Show previous invoice balances in a separate invoice section.  Does not require invoice_sections to be enabled.',
4659     'type'        => 'checkbox',
4660   },
4661
4662   {
4663     'key'         => 'previous_balance-summary_only',
4664     'section'     => 'invoicing',
4665     'description' => 'Only show a single line summarizing the total previous balance rather than one line per invoice.',
4666     'type'        => 'checkbox',
4667   },
4668
4669   {
4670     'key'         => 'previous_balance-show_credit',
4671     'section'     => 'invoicing',
4672     'description' => 'Show the customer\'s credit balance on invoices when applicable.',
4673     'type'        => 'checkbox',
4674   },
4675
4676   {
4677     'key'         => 'previous_balance-show_on_statements',
4678     'section'     => 'invoicing',
4679     'description' => 'Show previous invoices on statements, without itemized charges.',
4680     'type'        => 'checkbox',
4681   },
4682
4683   {
4684     'key'         => 'previous_balance-payments_since',
4685     'section'     => 'invoicing',
4686     'description' => 'Instead of showing payments (and credits) applied to the invoice, show those received since the previous invoice date.',
4687     'type'        => 'checkbox',
4688   },
4689
4690   {
4691     'key'         => 'previous_invoice_history',
4692     'section'     => 'invoicing',
4693     'description' => 'Show a month-by-month history of the customer\'s '.
4694                      'billing amounts.  This requires template '.
4695                      'modification and is currently not supported on the '.
4696                      'stock template.',
4697     'type'        => 'checkbox',
4698   },
4699
4700   {
4701     'key'         => 'balance_due_below_line',
4702     'section'     => 'invoicing',
4703     'description' => 'Place the balance due message below a line.  Only meaningful when when invoice_sections is false.',
4704     'type'        => 'checkbox',
4705   },
4706
4707   {
4708     'key'         => 'always_show_tax',
4709     'section'     => 'invoicing',
4710     'description' => 'Show a line for tax on the invoice even when the tax is zero.  Optionally provide text for the tax name to show.',
4711     'type'        => [ qw(checkbox text) ],
4712   },
4713
4714   {
4715     'key'         => 'address_standardize_method',
4716     'section'     => 'UI', #???
4717     'description' => 'Method for standardizing customer addresses.',
4718     'type'        => 'select',
4719     'select_hash' => [ '' => '',
4720                        'usps'     => 'U.S. Postal Service',
4721                        'uscensus' => 'U.S. Census Bureau',
4722                        'ezlocate' => 'EZLocate',
4723                        'melissa'  => 'Melissa WebSmart',
4724                        'freeside' => 'Freeside web service (support contract required)',
4725                      ],
4726   },
4727
4728   {
4729     'key'         => 'usps_webtools-userid',
4730     'section'     => 'UI',
4731     '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.',
4732     'type'        => 'text',
4733   },
4734
4735   {
4736     'key'         => 'usps_webtools-password',
4737     'section'     => 'UI',
4738     '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.',
4739     'type'        => 'text',
4740   },
4741
4742   {
4743     'key'         => 'ezlocate-userid',
4744     'section'     => 'UI',
4745     'description' => 'User ID for EZ-Locate service.  See <a href="http://www.geocode.com/">the TomTom website</a> for access and pricing information.',
4746     'type'        => 'text',
4747   },
4748
4749   {
4750     'key'         => 'ezlocate-password',
4751     'section'     => 'UI',
4752     'description' => 'Password for EZ-Locate service.',
4753     'type'        => 'text'
4754   },
4755
4756   {
4757     'key'         => 'melissa-userid',
4758     'section'     => 'UI', # it's really not...
4759     'description' => 'User ID for Melissa WebSmart service.  See <a href="http://www.melissadata.com/">the Melissa website</a> for access and pricing.',
4760     'type'        => 'text',
4761   },
4762
4763   {
4764     'key'         => 'melissa-enable_geocoding',
4765     'section'     => 'UI',
4766     'description' => 'Use the Melissa service for census tract and coordinate lookups.  Enable this only if your subscription includes geocoding access.',
4767     'type'        => 'checkbox',
4768   },
4769
4770   {
4771     'key'         => 'cust_main-auto_standardize_address',
4772     'section'     => 'UI',
4773     'description' => 'When using USPS web tools, automatically standardize the address without asking.',
4774     'type'        => 'checkbox',
4775   },
4776
4777   {
4778     'key'         => 'cust_main-require_censustract',
4779     'section'     => 'UI',
4780     'description' => 'Customer is required to have a census tract.  Useful for FCC form 477 reports. See also: cust_main-auto_standardize_address',
4781     'type'        => 'checkbox',
4782   },
4783
4784   {
4785     'key'         => 'cust_main-no_city_in_address',
4786     'section'     => 'UI',
4787     'description' => 'Turn off City for billing & shipping addresses',
4788     'type'        => 'checkbox',
4789   },
4790
4791   {
4792     'key'         => 'census_year',
4793     'section'     => 'UI',
4794     'description' => 'The year to use in census tract lookups.  NOTE: you need to select 2012 or 2013 for Year 2010 Census tract codes.  A selection of 2011 provides Year 2000 Census tract codes.  Use the freeside-censustract-update tool if exisitng customers need to be changed.',
4795     'type'        => 'select',
4796     'select_enum' => [ qw( 2017 2016 2015 ) ],
4797   },
4798
4799   {
4800     'key'         => 'tax_district_method',
4801     'section'     => 'billing', # 'UI', #???
4802     'description' => 'The method to use to look up tax district codes.',
4803     'type'        => 'select',
4804     #'select_hash' => [ FS::Misc::Geo::get_district_methods() ],
4805     #after RT#13763, using FS::Misc::Geo here now causes a dependancy loop :/
4806     'select_hash' => [
4807                        ''         => '',
4808                        'wa_sales' => 'Washington sales tax',
4809                      ],
4810   },
4811
4812   {
4813     'key'         => 'tax_district_taxname',
4814     'section'     => 'billing',
4815     'description' => 'The tax name to display on the invoice for district sales taxes. Defaults to "Tax".',
4816     'type'        => 'text',
4817   },
4818
4819   {
4820     'key'         => 'company_latitude',
4821     'section'     => 'UI',
4822     'description' => 'Your company latitude (-90 through 90)',
4823     'type'        => 'text',
4824   },
4825
4826   {
4827     'key'         => 'company_longitude',
4828     'section'     => 'UI',
4829     'description' => 'Your company longitude (-180 thru 180)',
4830     'type'        => 'text',
4831   },
4832
4833   {
4834     'key'         => 'geocode_module',
4835     'section'     => '',
4836     'description' => 'Module to geocode (retrieve a latitude and longitude for) addresses',
4837     'type'        => 'select',
4838     'select_enum' => [ 'Geo::Coder::Googlev3' ],
4839   },
4840
4841   {
4842     'key'         => 'geocode-require_nw_coordinates',
4843     'section'     => 'UI',
4844     'description' => 'Require latitude and longitude in the North Western quadrant, e.g. for North American co-ordinates, etc.',
4845     'type'        => 'checkbox',
4846   },
4847
4848   {
4849     'key'         => 'disable_acl_changes',
4850     'section'     => '',
4851     'description' => 'Disable all ACL changes, for demos.',
4852     'type'        => 'checkbox',
4853   },
4854
4855   {
4856     'key'         => 'disable_settings_changes',
4857     'section'     => '',
4858     'description' => 'Disable all settings changes, for demos, except for the usernames given in the comma-separated list.',
4859     'type'        => [qw( checkbox text )],
4860   },
4861
4862   {
4863     'key'         => 'cust_main-edit_agent_custid',
4864     'section'     => 'UI',
4865     'description' => 'Enable editing of the agent_custid field.',
4866     'type'        => 'checkbox',
4867   },
4868
4869   {
4870     'key'         => 'cust_main-default_agent_custid',
4871     'section'     => 'UI',
4872     'description' => 'Display the agent_custid field when available instead of the custnum field.  Restart Apache after changing.',
4873     'type'        => 'checkbox',
4874   },
4875
4876   {
4877     'key'         => 'cust_main-title-display_custnum',
4878     'section'     => 'UI',
4879     'description' => 'Add the display_custom (agent_custid or custnum) to the title on customer view pages.',
4880     'type'        => 'checkbox',
4881   },
4882
4883   {
4884     'key'         => 'cust_bill-default_agent_invid',
4885     'section'     => 'UI',
4886     'description' => 'Display the agent_invid field when available instead of the invnum field.',
4887     'type'        => 'checkbox',
4888   },
4889
4890   {
4891     'key'         => 'cust_main-auto_agent_custid',
4892     'section'     => 'UI',
4893     'description' => 'Automatically assign an agent_custid - select format',
4894     'type'        => 'select',
4895     'select_hash' => [ '' => 'No',
4896                        '1YMMXXXXXXXX' => '1YMMXXXXXXXX',
4897                      ],
4898   },
4899
4900   {
4901     'key'         => 'cust_main-custnum-display_prefix',
4902     'section'     => 'UI',
4903     'description' => 'Prefix the customer number with this string for display purposes.',
4904     'type'        => 'text',
4905     'per_agent'   => 1,
4906   },
4907
4908   {
4909     'key'         => 'cust_main-custnum-display_length',
4910     'section'     => 'UI',
4911     'description' => 'Zero fill the customer number to this many digits for display purposes.  Restart Apache after changing.',
4912     'type'        => 'text',
4913   },
4914
4915   {
4916     'key'         => 'cust_main-default_areacode',
4917     'section'     => 'UI',
4918     'description' => 'Default area code for customers.',
4919     'type'        => 'text',
4920   },
4921
4922   {
4923     'key'         => 'order_pkg-no_start_date',
4924     'section'     => 'UI',
4925     'description' => 'Don\'t set a default start date for new packages.',
4926     'type'        => 'checkbox',
4927   },
4928
4929   {
4930     'key'         => 'part_pkg-delay_start',
4931     'section'     => '',
4932     'description' => 'Enabled "delayed start" option for packages.',
4933     'type'        => 'checkbox',
4934   },
4935
4936   {
4937     'key'         => 'part_pkg-delay_cancel-days',
4938     'section'     => '',
4939     'description' => 'Number of days to suspend when using automatic suspension period before cancel (default is 1)',
4940     'type'        => 'text',
4941     'validate'    => sub { (($_[0] =~ /^\d*$/) && (($_[0] eq '') || $_[0]))
4942                            ? ''
4943                            : 'Must specify an integer number of days' }
4944   },
4945
4946   {
4947     'key'         => 'mcp_svcpart',
4948     'section'     => '',
4949     'description' => 'Master Control Program svcpart.  Leave this blank.',
4950     'type'        => 'text', #select-part_svc
4951   },
4952
4953   {
4954     'key'         => 'cust_bill-max_same_services',
4955     'section'     => 'invoicing',
4956     '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.',
4957     'type'        => 'text',
4958   },
4959
4960   {
4961     'key'         => 'cust_bill-consolidate_services',
4962     'section'     => 'invoicing',
4963     'description' => 'Consolidate service display into fewer lines on invoices rather than one per service.',
4964     'type'        => 'checkbox',
4965   },
4966
4967   {
4968     'key'         => 'suspend_email_admin',
4969     'section'     => '',
4970     'description' => 'Destination admin email address to enable suspension notices',
4971     'type'        => 'text',
4972   },
4973
4974   {
4975     'key'         => 'unsuspend_email_admin',
4976     'section'     => '',
4977     'description' => 'Destination admin email address to enable unsuspension notices',
4978     'type'        => 'text',
4979   },
4980
4981   {
4982     'key'         => 'email_report-subject',
4983     'section'     => '',
4984     'description' => 'Subject for reports emailed by freeside-fetch.  Defaults to "Freeside report".',
4985     'type'        => 'text',
4986   },
4987
4988   {
4989     'key'         => 'selfservice-head',
4990     'section'     => 'self-service',
4991     'description' => 'HTML for the HEAD section of the self-service interface, typically used for LINK stylesheet tags',
4992     'type'        => 'textarea', #htmlarea?
4993     'per_agent'   => 1,
4994   },
4995
4996
4997   {
4998     'key'         => 'selfservice-body_header',
4999     'section'     => 'self-service',
5000     'description' => 'HTML header for the self-service interface',
5001     'type'        => 'textarea', #htmlarea?
5002     'per_agent'   => 1,
5003   },
5004
5005   {
5006     'key'         => 'selfservice-body_footer',
5007     'section'     => 'self-service',
5008     'description' => 'HTML footer for the self-service interface',
5009     'type'        => 'textarea', #htmlarea?
5010     'per_agent'   => 1,
5011   },
5012
5013
5014   {
5015     'key'         => 'selfservice-body_bgcolor',
5016     'section'     => 'self-service',
5017     'description' => 'HTML background color for the self-service interface, for example, #FFFFFF',
5018     'type'        => 'text',
5019     'per_agent'   => 1,
5020   },
5021
5022   {
5023     'key'         => 'selfservice-box_bgcolor',
5024     'section'     => 'self-service',
5025     'description' => 'HTML color for self-service interface input boxes, for example, #C0C0C0',
5026     'type'        => 'text',
5027     'per_agent'   => 1,
5028   },
5029
5030   {
5031     'key'         => 'selfservice-stripe1_bgcolor',
5032     'section'     => 'self-service',
5033     'description' => 'HTML color for self-service interface lists (primary stripe), for example, #FFFFFF',
5034     'type'        => 'text',
5035     'per_agent'   => 1,
5036   },
5037
5038   {
5039     'key'         => 'selfservice-stripe2_bgcolor',
5040     'section'     => 'self-service',
5041     'description' => 'HTML color for self-service interface lists (alternate stripe), for example, #DDDDDD',
5042     'type'        => 'text',
5043     'per_agent'   => 1,
5044   },
5045
5046   {
5047     'key'         => 'selfservice-text_color',
5048     'section'     => 'self-service',
5049     'description' => 'HTML text color for the self-service interface, for example, #000000',
5050     'type'        => 'text',
5051     'per_agent'   => 1,
5052   },
5053
5054   {
5055     'key'         => 'selfservice-link_color',
5056     'section'     => 'self-service',
5057     'description' => 'HTML link color for the self-service interface, for example, #0000FF',
5058     'type'        => 'text',
5059     'per_agent'   => 1,
5060   },
5061
5062   {
5063     'key'         => 'selfservice-vlink_color',
5064     'section'     => 'self-service',
5065     'description' => 'HTML visited link color for the self-service interface, for example, #FF00FF',
5066     'type'        => 'text',
5067     'per_agent'   => 1,
5068   },
5069
5070   {
5071     'key'         => 'selfservice-hlink_color',
5072     'section'     => 'self-service',
5073     'description' => 'HTML hover link color for the self-service interface, for example, #808080',
5074     'type'        => 'text',
5075     'per_agent'   => 1,
5076   },
5077
5078   {
5079     'key'         => 'selfservice-alink_color',
5080     'section'     => 'self-service',
5081     'description' => 'HTML active (clicked) link color for the self-service interface, for example, #808080',
5082     'type'        => 'text',
5083     'per_agent'   => 1,
5084   },
5085
5086   {
5087     'key'         => 'selfservice-font',
5088     'section'     => 'self-service',
5089     'description' => 'HTML font CSS for the self-service interface, for example, 0.9em/1.5em Arial, Helvetica, Geneva, sans-serif',
5090     'type'        => 'text',
5091     'per_agent'   => 1,
5092   },
5093
5094   {
5095     'key'         => 'selfservice-no_logo',
5096     'section'     => 'self-service',
5097     'description' => 'Disable the logo in self-service',
5098     'type'        => 'checkbox',
5099     'per_agent'   => 1,
5100   },
5101
5102   {
5103     'key'         => 'selfservice-title_color',
5104     'section'     => 'self-service',
5105     'description' => 'HTML color for the self-service title, for example, #000000',
5106     'type'        => 'text',
5107     'per_agent'   => 1,
5108   },
5109
5110   {
5111     'key'         => 'selfservice-title_align',
5112     'section'     => 'self-service',
5113     'description' => 'HTML alignment for the self-service title, for example, center',
5114     'type'        => 'text',
5115     'per_agent'   => 1,
5116   },
5117   {
5118     'key'         => 'selfservice-title_size',
5119     'section'     => 'self-service',
5120     'description' => 'HTML font size for the self-service title, for example, 3',
5121     'type'        => 'text',
5122     'per_agent'   => 1,
5123   },
5124
5125   {
5126     'key'         => 'selfservice-title_left_image',
5127     'section'     => 'self-service',
5128     'description' => 'Image used for the top of the menu in the self-service interface, in PNG format.',
5129     'type'        => 'image',
5130     'per_agent'   => 1,
5131   },
5132
5133   {
5134     'key'         => 'selfservice-title_right_image',
5135     'section'     => 'self-service',
5136     'description' => 'Image used for the top of the menu in the self-service interface, in PNG format.',
5137     'type'        => 'image',
5138     'per_agent'   => 1,
5139   },
5140
5141   {
5142     'key'         => 'selfservice-menu_disable',
5143     'section'     => 'self-service',
5144     'description' => 'Disable the selected menu entries in the self-service menu',
5145     'type'        => 'selectmultiple',
5146     'select_enum' => [ #false laziness w/myaccount_menu.html
5147                        'Overview',
5148                        'Purchase',
5149                        'Purchase additional package',
5150                        'Recharge my account with a credit card',
5151                        'Recharge my account with a check',
5152                        'Recharge my account with a prepaid card',
5153                        'View my usage',
5154                        'Create a ticket',
5155                        'Setup my services',
5156                        'Change my information',
5157                        'Change billing address',
5158                        'Change service address',
5159                        'Change payment information',
5160                        'Change packages',
5161                        'Change password(s)',
5162                        'Logout',
5163                      ],
5164     'per_agent'   => 1,
5165   },
5166
5167   {
5168     'key'         => 'selfservice-menu_skipblanks',
5169     'section'     => 'self-service',
5170     'description' => 'Skip blank (spacer) entries in the self-service menu',
5171     'type'        => 'checkbox',
5172     'per_agent'   => 1,
5173   },
5174
5175   {
5176     'key'         => 'selfservice-menu_skipheadings',
5177     'section'     => 'self-service',
5178     'description' => 'Skip the unclickable heading entries in the self-service menu',
5179     'type'        => 'checkbox',
5180     'per_agent'   => 1,
5181   },
5182
5183   {
5184     'key'         => 'selfservice-menu_bgcolor',
5185     'section'     => 'self-service',
5186     'description' => 'HTML color for the self-service menu, for example, #C0C0C0',
5187     'type'        => 'text',
5188     'per_agent'   => 1,
5189   },
5190
5191   {
5192     'key'         => 'selfservice-menu_fontsize',
5193     'section'     => 'self-service',
5194     'description' => 'HTML font size for the self-service menu, for example, -1',
5195     'type'        => 'text',
5196     'per_agent'   => 1,
5197   },
5198   {
5199     'key'         => 'selfservice-menu_nounderline',
5200     'section'     => 'self-service',
5201     'description' => 'Styles menu links in the self-service without underlining.',
5202     'type'        => 'checkbox',
5203     'per_agent'   => 1,
5204   },
5205
5206
5207   {
5208     'key'         => 'selfservice-menu_top_image',
5209     'section'     => 'self-service',
5210     'description' => 'Image used for the top of the menu in the self-service interface, in PNG format.',
5211     'type'        => 'image',
5212     'per_agent'   => 1,
5213   },
5214
5215   {
5216     'key'         => 'selfservice-menu_body_image',
5217     'section'     => 'self-service',
5218     'description' => 'Repeating image used for the body of the menu in the self-service interface, in PNG format.',
5219     'type'        => 'image',
5220     'per_agent'   => 1,
5221   },
5222
5223   {
5224     'key'         => 'selfservice-menu_bottom_image',
5225     'section'     => 'self-service',
5226     'description' => 'Image used for the bottom of the menu in the self-service interface, in PNG format.',
5227     'type'        => 'image',
5228     'per_agent'   => 1,
5229   },
5230
5231   {
5232     'key'         => 'selfservice-view_usage_nodomain',
5233     'section'     => 'self-service',
5234     'description' => 'Show usernames without their domains in "View my usage" in the self-service interface.',
5235     'type'        => 'checkbox',
5236   },
5237
5238   {
5239     'key'         => 'selfservice-login_banner_image',
5240     'section'     => 'self-service',
5241     'description' => 'Banner image shown on the login page, in PNG format.',
5242     'type'        => 'image',
5243   },
5244
5245   {
5246     'key'         => 'selfservice-login_banner_url',
5247     'section'     => 'self-service',
5248     'description' => 'Link for the login banner.',
5249     'type'        => 'text',
5250   },
5251
5252   {
5253     'key'         => 'ng_selfservice-menu',
5254     'section'     => 'self-service',
5255     'description' => 'Custom menu for the next-generation self-service interface.  Each line is in the format "link Label", for example "main.php Home".  Sub-menu items are listed on subsequent lines.  Blank lines terminate the submenu.', #more docs/examples would be helpful
5256     'type'        => 'textarea',
5257   },
5258
5259   {
5260     'key'         => 'signup-no_company',
5261     'section'     => 'self-service',
5262     'description' => "Don't display a field for company name on signup.",
5263     'type'        => 'checkbox',
5264   },
5265
5266   {
5267     'key'         => 'signup-recommend_email',
5268     'section'     => 'self-service',
5269     'description' => 'Encourage the entry of an invoicing email address on signup.',
5270     'type'        => 'checkbox',
5271   },
5272
5273   {
5274     'key'         => 'signup-recommend_daytime',
5275     'section'     => 'self-service',
5276     'description' => 'Encourage the entry of a daytime phone number on signup.',
5277     'type'        => 'checkbox',
5278   },
5279
5280   {
5281     'key'         => 'signup-duplicate_cc-warn_hours',
5282     'section'     => 'self-service',
5283     'description' => 'Issue a warning if the same credit card is used for multiple signups within this many hours.',
5284     'type'        => 'text',
5285   },
5286
5287   {
5288     'key'         => 'svc_phone-radius-password',
5289     'section'     => 'telephony',
5290     'description' => 'Password when exporting svc_phone records to RADIUS',
5291     'type'        => 'select',
5292     'select_hash' => [
5293       '' => 'Use default from svc_phone-radius-default_password config',
5294       'countrycode_phonenum' => 'Phone number (with country code)',
5295     ],
5296   },
5297
5298   {
5299     'key'         => 'svc_phone-radius-default_password',
5300     'section'     => 'telephony',
5301     'description' => 'Default password when exporting svc_phone records to RADIUS',
5302     'type'        => 'text',
5303   },
5304
5305   {
5306     'key'         => 'svc_phone-allow_alpha_phonenum',
5307     'section'     => 'telephony',
5308     'description' => 'Allow letters in phone numbers.',
5309     'type'        => 'checkbox',
5310   },
5311
5312   {
5313     'key'         => 'svc_phone-domain',
5314     'section'     => 'telephony',
5315     'description' => 'Track an optional domain association with each phone service.',
5316     'type'        => 'checkbox',
5317   },
5318
5319   {
5320     'key'         => 'svc_phone-phone_name-max_length',
5321     'section'     => 'telephony',
5322     '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.',
5323     'type'        => 'text',
5324   },
5325
5326   {
5327     'key'         => 'svc_phone-random_pin',
5328     'section'     => 'telephony',
5329     'description' => 'Number of random digits to generate in the "PIN" field, if empty.',
5330     'type'        => 'text',
5331   },
5332
5333   {
5334     'key'         => 'svc_phone-lnp',
5335     'section'     => 'telephony',
5336     'description' => 'Enables Number Portability features for svc_phone',
5337     'type'        => 'checkbox',
5338   },
5339
5340   {
5341     'key'         => 'svc_phone-bulk_provision_simple',
5342     'section'     => 'telephony',
5343     'description' => 'Bulk provision phone numbers with a simple number range instead of from DID vendor orders',
5344     'type'        => 'checkbox',
5345   },
5346
5347   {
5348     'key'         => 'default_phone_countrycode',
5349     'section'     => 'telephony',
5350     'description' => 'Default countrycode',
5351     'type'        => 'text',
5352   },
5353
5354   {
5355     'key'         => 'cdr-charged_party-field',
5356     'section'     => 'telephony',
5357     'description' => 'Set the charged_party field of CDRs to this field.',
5358     'type'        => 'select-sub',
5359     'options_sub' => sub { my $fields = FS::cdr->table_info->{'fields'};
5360                            map { $_ => $fields->{$_}||$_ }
5361                            grep { $_ !~ /^(acctid|charged_party)$/ }
5362                            FS::Schema::dbdef->table('cdr')->columns;
5363                          },
5364     'option_sub'  => sub { my $f = shift;
5365                            FS::cdr->table_info->{'fields'}{$f} || $f;
5366                          },
5367   },
5368
5369   #probably deprecate in favor of cdr-charged_party-field above
5370   {
5371     'key'         => 'cdr-charged_party-accountcode',
5372     'section'     => 'telephony',
5373     'description' => 'Set the charged_party field of CDRs to the accountcode.',
5374     'type'        => 'checkbox',
5375   },
5376
5377   {
5378     'key'         => 'cdr-charged_party-accountcode-trim_leading_0s',
5379     'section'     => 'telephony',
5380     'description' => 'When setting the charged_party field of CDRs to the accountcode, trim any leading zeros.',
5381     'type'        => 'checkbox',
5382   },
5383
5384 #  {
5385 #    'key'         => 'cdr-charged_party-truncate_prefix',
5386 #    'section'     => '',
5387 #    'description' => 'If the charged_party field has this prefix, truncate it to the length in cdr-charged_party-truncate_length.',
5388 #    'type'        => 'text',
5389 #  },
5390 #
5391 #  {
5392 #    'key'         => 'cdr-charged_party-truncate_length',
5393 #    'section'     => '',
5394 #    'description' => 'If the charged_party field has the prefix in cdr-charged_party-truncate_prefix, truncate it to this length.',
5395 #    'type'        => 'text',
5396 #  },
5397
5398   {
5399     'key'         => 'cdr-skip_duplicate_rewrite',
5400     'section'     => 'telephony',
5401     'description' => 'Use the freeside-cdrrewrited daemon to prevent billing CDRs with a src, dst and calldate identical to an existing CDR',
5402     'type'        => 'checkbox',
5403   },
5404
5405   {
5406     'key'         => 'cdr-charged_party_rewrite',
5407     'section'     => 'telephony',
5408     '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*.',
5409     'type'        => 'checkbox',
5410   },
5411
5412   {
5413     'key'         => 'cdr-taqua-da_rewrite',
5414     'section'     => 'telephony',
5415     '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.',
5416     'type'        => 'text',
5417   },
5418
5419   {
5420     'key'         => 'cdr-taqua-accountcode_rewrite',
5421     'section'     => 'telephony',
5422     'description' => 'For the Taqua CDR format, pull accountcodes from secondary CDRs with matching sessionNumber.',
5423     'type'        => 'checkbox',
5424   },
5425
5426   {
5427     'key'         => 'cdr-taqua-callerid_rewrite',
5428     'section'     => 'telephony',
5429     'description' => 'For the Taqua CDR format, pull Caller ID blocking information from secondary CDRs.',
5430     'type'        => 'checkbox',
5431   },
5432
5433   {
5434     'key'         => 'cdr-asterisk_australia_rewrite',
5435     'section'     => 'telephony',
5436     'description' => 'For Asterisk CDRs, assign CDR type numbers based on Australian conventions.',
5437     'type'        => 'checkbox',
5438   },
5439
5440   {
5441     'key'         => 'cdr-userfield_dnis_rewrite',
5442     'section'     => 'telephony',
5443     'description' => 'If the CDR userfield contains "DNIS=" followed by a sequence of digits, use that as the destination number for the call.',
5444     'type'        => 'checkbox',
5445   },
5446
5447   {
5448     'key'         => 'cdr-intl_to_domestic_rewrite',
5449     'section'     => 'telephony',
5450     'description' => 'Strip the "011" international prefix from CDR destination numbers if the rest of the number is 7 digits or shorter, and so probably does not contain a country code.',
5451     'type'        => 'checkbox',
5452   },
5453
5454   {
5455     'key'         => 'cdr-gsm_tap3-sender',
5456     'section'     => 'telephony',
5457     'description' => 'GSM TAP3 Sender network (5 letter code)',
5458     'type'        => 'text',
5459   },
5460
5461   {
5462     'key'         => 'cust_pkg-show_autosuspend',
5463     'section'     => 'UI',
5464     'description' => 'Show package auto-suspend dates.  Use with caution for now; can slow down customer view for large insallations.',
5465     'type'        => 'checkbox',
5466   },
5467
5468   {
5469     'key'         => 'cdr-asterisk_forward_rewrite',
5470     'section'     => 'telephony',
5471     '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").',
5472     'type'        => 'checkbox',
5473   },
5474
5475   {
5476     'key'         => 'mc-outbound_packages',
5477     'section'     => '',
5478     'description' => "Don't use this.",
5479     'type'        => 'select-part_pkg',
5480     'multiple'    => 1,
5481   },
5482
5483   {
5484     'key'         => 'disable-cust-pkg_class',
5485     'section'     => 'UI',
5486     'description' => 'Disable the two-step dropdown for selecting package class and package, and return to the classic single dropdown.',
5487     'type'        => 'checkbox',
5488   },
5489
5490   {
5491     'key'         => 'queued-max_kids',
5492     'section'     => '',
5493     'description' => 'Maximum number of queued processes.  Defaults to 10.',
5494     'type'        => 'text',
5495   },
5496
5497   {
5498     'key'         => 'queued-sleep_time',
5499     'section'     => '',
5500     '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.',
5501     'type'        => 'text',
5502   },
5503
5504   {
5505     'key'         => 'queue-no_history',
5506     'section'     => '',
5507     'description' => "Don't recreate the h_queue and h_queue_arg tables on upgrades.  This can save disk space for large installs, especially when using prepaid or multi-process billing.  After turning this option on, drop the h_queue and h_queue_arg tables, run freeside-dbdef-create and restart Apache and Freeside.",
5508     'type'        => 'checkbox',
5509   },
5510
5511   {
5512     'key'         => 'cancelled_cust-noevents',
5513     'section'     => 'billing',
5514     'description' => "Don't run events for cancelled customers",
5515     'type'        => 'checkbox',
5516   },
5517
5518   {
5519     'key'         => 'agent-invoice_template',
5520     'section'     => 'invoicing',
5521     'description' => 'Enable display/edit of old-style per-agent invoice template selection',
5522     'type'        => 'checkbox',
5523   },
5524
5525   {
5526     'key'         => 'svc_broadband-manage_link',
5527     'section'     => 'UI',
5528     'description' => 'URL for svc_broadband "Manage Device" link.  The following substitutions are available: $ip_addr and $mac_addr.',
5529     'type'        => 'text',
5530   },
5531
5532   {
5533     'key'         => 'svc_broadband-manage_link_text',
5534     'section'     => 'UI',
5535     'description' => 'Label for "Manage Device" link',
5536     'type'        => 'text',
5537   },
5538
5539   {
5540     'key'         => 'svc_broadband-manage_link_loc',
5541     'section'     => 'UI',
5542     'description' => 'Location for "Manage Device" link',
5543     'type'        => 'select',
5544     'select_hash' => [
5545       'bottom' => 'Near Unprovision link',
5546       'right'  => 'With export-related links',
5547     ],
5548   },
5549
5550   {
5551     'key'         => 'svc_broadband-manage_link-new_window',
5552     'section'     => 'UI',
5553     'description' => 'Open the "Manage Device" link in a new window',
5554     'type'        => 'checkbox',
5555   },
5556
5557   #more fine-grained, service def-level control could be useful eventually?
5558   {
5559     'key'         => 'svc_broadband-allow_null_ip_addr',
5560     'section'     => '',
5561     'description' => '',
5562     'type'        => 'checkbox',
5563   },
5564
5565   {
5566     'key'         => 'svc_hardware-check_mac_addr',
5567     'section'     => '', #?
5568     'description' => 'Require the "hardware address" field in hardware services to be a valid MAC address.',
5569     'type'        => 'checkbox',
5570   },
5571
5572   {
5573     'key'         => 'tax-report_groups',
5574     'section'     => '',
5575     'description' => 'List of grouping possibilities for tax names on reports, one per line, "label op value" (op can be = or !=).',
5576     'type'        => 'textarea',
5577   },
5578
5579   {
5580     'key'         => 'tax-cust_exempt-groups',
5581     'section'     => 'billing',
5582     '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).',
5583     'type'        => 'textarea',
5584   },
5585
5586   {
5587     'key'         => 'tax-cust_exempt-groups-require_individual_nums',
5588     'section'     => 'deprecated',
5589     'description' => 'Deprecated: see tax-cust_exempt-groups-num_req',
5590     'type'        => 'checkbox',
5591   },
5592
5593   {
5594     'key'         => 'tax-cust_exempt-groups-num_req',
5595     'section'     => 'billing',
5596     'description' => 'When using tax-cust_exempt-groups, control whether individual tax exemption numbers are required for exemption from different taxes.',
5597     'type'        => 'select',
5598     'select_hash' => [ ''            => 'Not required',
5599                        'residential' => 'Required for residential customers only',
5600                        'all'         => 'Required for all customers',
5601                      ],
5602   },
5603
5604   {
5605     'key'         => 'tax-round_per_line_item',
5606     'section'     => 'billing',
5607     'description' => 'Calculate tax and round to the nearest cent for each line item, rather than for the whole invoice.',
5608     'type'        => 'checkbox',
5609   },
5610
5611   {
5612     'key'         => 'cust_main-default_view',
5613     'section'     => 'UI',
5614     'description' => 'Default customer view, for users who have not selected a default view in their preferences.',
5615     'type'        => 'select',
5616     'select_hash' => [
5617       #false laziness w/view/cust_main.cgi and pref/pref.html
5618       'basics'          => 'Basics',
5619       'notes'           => 'Notes',
5620       'tickets'         => 'Tickets',
5621       'packages'        => 'Packages',
5622       'payment_history' => 'Payment History',
5623       'change_history'  => 'Change History',
5624       'jumbo'           => 'Jumbo',
5625     ],
5626   },
5627
5628   {
5629     'key'         => 'enable_tax_adjustments',
5630     'section'     => 'billing',
5631     'description' => 'Enable the ability to add manual tax adjustments.',
5632     'type'        => 'checkbox',
5633   },
5634
5635   {
5636     'key'         => 'rt-crontool',
5637     'section'     => '',
5638     'description' => 'Enable the RT CronTool extension.',
5639     'type'        => 'checkbox',
5640   },
5641
5642   {
5643     'key'         => 'pkg-balances',
5644     'section'     => 'billing',
5645     'description' => 'Enable per-package balances.',
5646     'type'        => 'checkbox',
5647   },
5648
5649   {
5650     'key'         => 'pkg-addon_classnum',
5651     'section'     => 'billing',
5652     'description' => 'Enable the ability to restrict additional package orders based on package class.',
5653     'type'        => 'checkbox',
5654   },
5655
5656   {
5657     'key'         => 'cust_main-edit_signupdate',
5658     'section'     => 'UI',
5659     'description' => 'Enable manual editing of the signup date.',
5660     'type'        => 'checkbox',
5661   },
5662
5663   {
5664     'key'         => 'svc_acct-disable_access_number',
5665     'section'     => 'UI',
5666     'description' => 'Disable access number selection.',
5667     'type'        => 'checkbox',
5668   },
5669
5670   {
5671     'key'         => 'cust_bill_pay_pkg-manual',
5672     'section'     => 'UI',
5673     'description' => 'Allow manual application of payments to line items.',
5674     'type'        => 'checkbox',
5675   },
5676
5677   {
5678     'key'         => 'cust_credit_bill_pkg-manual',
5679     'section'     => 'UI',
5680     'description' => 'Allow manual application of credits to line items.',
5681     'type'        => 'checkbox',
5682   },
5683
5684   {
5685     'key'         => 'breakage-days',
5686     'section'     => 'billing',
5687     '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.',
5688     'type'        => 'text',
5689     'per_agent'   => 1,
5690   },
5691
5692   {
5693     'key'         => 'breakage-pkg_class',
5694     'section'     => 'billing',
5695     'description' => 'Package class to use for breakage reconciliation.',
5696     'type'        => 'select-pkg_class',
5697   },
5698
5699   {
5700     'key'         => 'disable_cron_billing',
5701     'section'     => 'billing',
5702     '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.',
5703     'type'        => 'checkbox',
5704   },
5705
5706   {
5707     'key'         => 'svc_domain-edit_domain',
5708     'section'     => '',
5709     'description' => 'Enable domain renaming',
5710     'type'        => 'checkbox',
5711   },
5712
5713   {
5714     'key'         => 'enable_legacy_prepaid_income',
5715     'section'     => '',
5716     '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.",
5717     'type'        => 'checkbox',
5718   },
5719
5720   {
5721     'key'         => 'cust_main-exports',
5722     'section'     => '',
5723     'description' => 'Export(s) to call on cust_main insert, modification and deletion.',
5724     'type'        => 'select-sub',
5725     'multiple'    => 1,
5726     'options_sub' => sub {
5727       require FS::Record;
5728       require FS::part_export;
5729       my @part_export =
5730         map { qsearch( 'part_export', {exporttype => $_ } ) }
5731           keys %{FS::part_export::export_info('cust_main')};
5732       map { $_->exportnum => $_->exportname } @part_export;
5733     },
5734     'option_sub'  => sub {
5735       require FS::Record;
5736       require FS::part_export;
5737       my $part_export = FS::Record::qsearchs(
5738         'part_export', { 'exportnum' => shift }
5739       );
5740       $part_export
5741         ? $part_export->exportname
5742         : '';
5743     },
5744   },
5745
5746   #false laziness w/above options_sub and option_sub
5747   {
5748     'key'         => 'cust_location-exports',
5749     'section'     => '',
5750     'description' => 'Export(s) to call on cust_location insert or modification',
5751     'type'        => 'select-sub',
5752     'multiple'    => 1,
5753     'options_sub' => sub {
5754       require FS::Record;
5755       require FS::part_export;
5756       my @part_export =
5757         map { qsearch( 'part_export', {exporttype => $_ } ) }
5758           keys %{FS::part_export::export_info('cust_location')};
5759       map { $_->exportnum => $_->exportname } @part_export;
5760     },
5761     'option_sub'  => sub {
5762       require FS::Record;
5763       require FS::part_export;
5764       my $part_export = FS::Record::qsearchs(
5765         'part_export', { 'exportnum' => shift }
5766       );
5767       $part_export
5768         ? $part_export->exportname
5769         : '';
5770     },
5771   },
5772
5773   {
5774     'key'         => 'cust_tag-location',
5775     'section'     => 'UI',
5776     'description' => 'Location where customer tags are displayed.',
5777     'type'        => 'select',
5778     'select_enum' => [ 'misc_info', 'top' ],
5779   },
5780
5781   {
5782     'key'         => 'cust_main-custom_link',
5783     'section'     => 'UI',
5784     'description' => 'URL to use as source for the "Custom" tab in the View Customer page.  The customer number will be appended, or you can insert "$custnum" to have it inserted elsewhere.  "$agentnum" will be replaced with the agent number, "$agent_custid" with be replaced with the agent customer ID (if any), and "$usernum" will be replaced with the employee number.',
5785     'type'        => 'textarea',
5786   },
5787
5788   {
5789     'key'         => 'cust_main-custom_content',
5790     'section'     => 'UI',
5791     'description' => 'As an alternative to cust_main-custom_link (leave it blank), the contant to display on this customer page, one item per line.  Available iems are: small_custview, birthdate, spouse_birthdate, svc_acct, svc_phone and svc_external.',
5792     'type'        => 'textarea',
5793   },
5794
5795   {
5796     'key'         => 'cust_main-custom_title',
5797     'section'     => 'UI',
5798     'description' => 'Title for the "Custom" tab in the View Customer page.',
5799     'type'        => 'text',
5800   },
5801
5802   {
5803     'key'         => 'part_pkg-default_suspend_bill',
5804     'section'     => 'billing',
5805     'description' => 'Default the "Continue recurring billing while suspended" flag to on for new package definitions.',
5806     'type'        => 'checkbox',
5807   },
5808
5809   {
5810     'key'         => 'qual-alt_address_format',
5811     'section'     => 'UI',
5812     'description' => 'Enable the alternate address format (location type, number, and kind) for qualifications.',
5813     'type'        => 'checkbox',
5814   },
5815
5816   {
5817     'key'         => 'prospect_main-alt_address_format',
5818     'section'     => 'UI',
5819     'description' => 'Enable the alternate address format (location type, number, and kind) for prospects.  Recommended if qual-alt_address_format is set and the main use of propects is for qualifications.',
5820     'type'        => 'checkbox',
5821   },
5822
5823   {
5824     'key'         => 'prospect_main-location_required',
5825     'section'     => 'UI',
5826     'description' => 'Require an address for prospects.  Recommended if the main use of propects is for qualifications.',
5827     'type'        => 'checkbox',
5828   },
5829
5830   {
5831     'key'         => 'note-classes',
5832     'section'     => 'deprecated',
5833     'description' => 'Use customer note classes (now automatically used if classes are defined)',
5834     'type'        => 'select',
5835     'select_hash' => [
5836                        0 => 'Disabled',
5837                        1 => 'Enabled',
5838                        2 => 'Enabled, with tabs',
5839                      ],
5840   },
5841
5842   {
5843     'key'         => 'svc_acct-cf_privatekey-message',
5844     'section'     => '',
5845     'description' => 'For internal use: HTML displayed when cf_privatekey field is set.',
5846     'type'        => 'textarea',
5847   },
5848
5849   {
5850     'key'         => 'menu-prepend_links',
5851     'section'     => 'UI',
5852     'description' => 'Links to prepend to the main menu, one per line, with format "URL Link Label (optional ALT popup)".',
5853     'type'        => 'textarea',
5854   },
5855
5856   {
5857     'key'         => 'cust_main-external_links',
5858     'section'     => 'UI',
5859     'description' => 'External links available in customer view, one per line, with format "URL Link Label (optional ALT popup)".  The URL will have custnum appended.',
5860     'type'        => 'textarea',
5861   },
5862
5863   {
5864     'key'         => 'svc_phone-did-summary',
5865     'section'     => 'invoicing',
5866     'description' => 'Experimental feature to enable DID activity summary on invoices, showing # DIDs activated/deactivated/ported-in/ported-out and total minutes usage, covering period since last invoice.',
5867     'type'        => 'checkbox',
5868   },
5869
5870   {
5871     'key'         => 'svc_acct-usage_seconds',
5872     'section'     => 'invoicing',
5873     'description' => 'Enable calculation of RADIUS usage time for invoices.  You must modify your template to display this information.',
5874     'type'        => 'checkbox',
5875   },
5876
5877   {
5878     'key'         => 'opensips_gwlist',
5879     'section'     => 'telephony',
5880     'description' => 'For svc_phone OpenSIPS dr_rules export, gwlist column value, per-agent',
5881     'type'        => 'text',
5882     'per_agent'   => 1,
5883     'agentonly'   => 1,
5884   },
5885
5886   {
5887     'key'         => 'opensips_description',
5888     'section'     => 'telephony',
5889     'description' => 'For svc_phone OpenSIPS dr_rules export, description column value, per-agent',
5890     'type'        => 'text',
5891     'per_agent'   => 1,
5892     'agentonly'   => 1,
5893   },
5894
5895   {
5896     'key'         => 'opensips_route',
5897     'section'     => 'telephony',
5898     'description' => 'For svc_phone OpenSIPS dr_rules export, routeid column value, per-agent',
5899     'type'        => 'text',
5900     'per_agent'   => 1,
5901     'agentonly'   => 1,
5902   },
5903
5904   {
5905     'key'         => 'cust_bill-no_recipients-error',
5906     'section'     => 'invoicing',
5907     '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.',
5908     'type'        => 'checkbox',
5909   },
5910
5911   {
5912     'key'         => 'cust_bill-latex_lineitem_maxlength',
5913     'section'     => 'deprecated',
5914     'description' => 'With old invoice_latex template, truncate long line items to this number of characters on typeset invoices, to avoid losing things off the right margin.  Defaults to 50.  (With current invoice_latex template, this is handled internally in the template itself instead.)',
5915     'type'        => 'text',
5916   },
5917
5918   {
5919     'key'         => 'invoice_payment_details',
5920     'section'     => 'invoicing',
5921     'description' => 'When displaying payments on an invoice, show the payment method used, including the check or credit card number.  Credit card numbers will be masked.',
5922     'type'        => 'checkbox',
5923   },
5924
5925   {
5926     'key'         => 'cust_main-status_module',
5927     'section'     => 'UI',
5928     '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.  Restart Apache after changing.', #other differences?
5929     'type'        => 'select',
5930     'select_enum' => [ 'Classic', 'Recurring' ],
5931   },
5932
5933   {
5934     'key'         => 'username-pound',
5935     'section'     => 'username',
5936     'description' => 'Allow the pound character (#) in usernames.',
5937     'type'        => 'checkbox',
5938   },
5939
5940   {
5941     'key'         => 'username-exclamation',
5942     'section'     => 'username',
5943     'description' => 'Allow the exclamation character (!) in usernames.',
5944     'type'        => 'checkbox',
5945   },
5946
5947   {
5948     'key'         => 'ie-compatibility_mode',
5949     'section'     => 'UI',
5950     '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.",
5951     'type'        => 'select',
5952     'select_enum' => [ '', '7', 'EmulateIE7', '8', 'EmulateIE8' ],
5953   },
5954
5955   {
5956     'key'         => 'disable_payauto_default',
5957     'section'     => 'UI',
5958     'description' => 'Disable the "Charge future payments to this (card|check) automatically" checkbox from defaulting to checked.',
5959     'type'        => 'checkbox',
5960   },
5961
5962   {
5963     'key'         => 'payment-history-report',
5964     'section'     => 'UI',
5965     'description' => 'Show a link to the raw database payment history report in the Reports menu.  DO NOT ENABLE THIS for modern installations.',
5966     'type'        => 'checkbox',
5967   },
5968
5969   {
5970     'key'         => 'svc_broadband-require-nw-coordinates',
5971     'section'     => 'deprecated',
5972     'description' => 'Deprecated; see geocode-require_nw_coordinates instead',
5973     'type'        => 'checkbox',
5974   },
5975
5976   {
5977     'key'         => 'cust-email-high-visibility',
5978     'section'     => 'UI',
5979     'description' => 'Move the invoicing e-mail address field to the top of the billing address section and highlight it.',
5980     'type'        => 'checkbox',
5981   },
5982
5983   {
5984     'key'         => 'cust-edit-alt-field-order',
5985     'section'     => 'UI',
5986     'description' => 'An alternate ordering of fields for the New Customer and Edit Customer screens.',
5987     'type'        => 'checkbox',
5988   },
5989
5990   {
5991     'key'         => 'cust_bill-enable_promised_date',
5992     'section'     => 'UI',
5993     'description' => 'Enable display/editing of the "promised payment date" field on invoices.',
5994     'type'        => 'checkbox',
5995   },
5996
5997   {
5998     'key'         => 'available-locales',
5999     'section'     => '',
6000     'description' => 'Limit available locales (employee preferences, per-customer locale selection, etc.) to a particular set.',
6001     'type'        => 'select-sub',
6002     'multiple'    => 1,
6003     'options_sub' => sub {
6004       map { $_ => FS::Locales->description($_) }
6005       FS::Locales->locales;
6006     },
6007     'option_sub'  => sub { FS::Locales->description(shift) },
6008   },
6009
6010   {
6011     'key'         => 'cust_main-require_locale',
6012     'section'     => 'UI',
6013     'description' => 'Require an explicit locale to be chosen for new customers.',
6014     'type'        => 'checkbox',
6015   },
6016
6017   {
6018     'key'         => 'translate-auto-insert',
6019     'section'     => '',
6020     'description' => 'Auto-insert untranslated strings for selected non-en_US locales with their default/en_US values.  Do not turn this on unless translating the interface into a new language.  Restart Apache after changing.',
6021     'type'        => 'select',
6022     'multiple'    => 1,
6023     'select_enum' => [ grep { $_ ne 'en_US' } FS::Locales::locales ],
6024   },
6025
6026   {
6027     'key'         => 'svc_acct-tower_sector',
6028     'section'     => '',
6029     'description' => 'Track tower and sector for svc_acct (account) services.',
6030     'type'        => 'checkbox',
6031   },
6032
6033   {
6034     'key'         => 'cdr-prerate',
6035     'section'     => 'telephony',
6036     'description' => 'Experimental feature to rate CDRs immediately, rather than waiting until invoice generation time.  Can reduce invoice generation time when processing lots of CDRs.  Currently works with "VoIP/telco CDR rating (standard)" price plans using "Phone numbers (svc_phone.phonenum)" CDR service matching, without any included minutes.',
6037     'type'        => 'checkbox',
6038   },
6039
6040   {
6041     'key'         => 'cdr-prerate-cdrtypenums',
6042     'section'     => 'telephony',
6043     'description' => 'When using cdr-prerate to rate CDRs immediately, limit processing to these CDR types.',
6044     'type'        => 'select-sub',
6045     'multiple'    => 1,
6046     'options_sub' => sub { require FS::Record;
6047                            require FS::cdr_type;
6048                            map { $_->cdrtypenum => $_->cdrtypename }
6049                                FS::Record::qsearch( 'cdr_type',
6050                                                     {} #{ 'disabled' => '' }
6051                                                   );
6052                          },
6053     'option_sub'  => sub { require FS::Record;
6054                            require FS::cdr_type;
6055                            my $cdr_type = FS::Record::qsearchs(
6056                              'cdr_type', { 'cdrtypenum'=>shift } );
6057                            $cdr_type ? $cdr_type->cdrtypename : '';
6058                          },
6059   },
6060
6061   {
6062     'key'         => 'cdr-minutes_priority',
6063     'section'     => 'telephony',
6064     'description' => 'Priority rule for assigning included minutes to CDRs.',
6065     'type'        => 'select',
6066     'select_hash' => [
6067       ''          => 'No specific order',
6068       'time'      => 'Chronological',
6069       'rate_high' => 'Highest rate first',
6070       'rate_low'  => 'Lowest rate first',
6071     ],
6072   },
6073
6074   {
6075     'key'         => 'cdr-lrn_lookup',
6076     'section'     => 'telephony',
6077     'description' => 'Look up LRNs of destination numbers for exact matching to the terminating carrier.  This feature requires a Freeside support contract for paid access to the central NPAC database; see <a href ="#support-key">support-key</a>.',
6078     'type'        => 'checkbox',
6079   },
6080
6081   {
6082     'key'         => 'brand-agent',
6083     'section'     => 'UI',
6084     'description' => 'Brand the backoffice interface (currently Help->About) using the company_name, company_url and logo.png configuration settings of the selected agent.  Typically used when selling or bundling hosted access to the backoffice interface.  NOTE: The AGPL software license has specific requirements for source code availability in this situation.',
6085     'type'        => 'select-agent',
6086   },
6087
6088   {
6089     'key'         => 'cust_class-tax_exempt',
6090     'section'     => 'billing',
6091     'description' => 'Control the tax exemption flag per customer class rather than per indivual customer.',
6092     'type'        => 'checkbox',
6093   },
6094
6095   {
6096     'key'         => 'selfservice-billing_history-line_items',
6097     'section'     => 'self-service',
6098     'description' => 'Return line item billing detail for the self-service billing_history API call.',
6099     'type'        => 'checkbox',
6100   },
6101
6102   {
6103     'key'         => 'selfservice-default_cdr_format',
6104     'section'     => 'self-service',
6105     'description' => 'Format for showing outbound CDRs in self-service.  The per-package option overrides this.',
6106     'type'        => 'select',
6107     'select_hash' => \@cdr_formats,
6108   },
6109
6110   {
6111     'key'         => 'selfservice-default_inbound_cdr_format',
6112     'section'     => 'self-service',
6113     'description' => 'Format for showing inbound CDRs in self-service.  The per-package option overrides this.  Leave blank to avoid showing these CDRs.',
6114     'type'        => 'select',
6115     'select_hash' => \@cdr_formats,
6116   },
6117
6118   {
6119     'key'         => 'selfservice-hide_cdr_price',
6120     'section'     => 'self-service',
6121     'description' => 'Don\'t show the "Price" column on CDRs in self-service.',
6122     'type'        => 'checkbox',
6123   },
6124
6125   {
6126     'key'         => 'selfservice-enable_payment_without_balance',
6127     'section'     => 'self-service',
6128     'description' => 'Allow selfservice customers to make payments even if balance is zero or below (resulting in an unapplied payment and negative balance.)',
6129     'type'        => 'checkbox',
6130   },
6131
6132   {
6133     'key'         => 'selfservice-ACH_info_readonly',
6134     'section'     => 'self-service',
6135     'description' => 'make ACH on self service portal read only',
6136     'type'        => 'checkbox',
6137   },
6138
6139   {
6140     'key'         => 'selfservice-announcement',
6141     'section'     => 'self-service',
6142     'description' => 'HTML announcement to display to all authenticated users on account overview page',
6143     'type'        => 'textarea',
6144   },
6145
6146   {
6147     'key'         => 'logout-timeout',
6148     'section'     => 'UI',
6149     'description' => 'If set, automatically log users out of the backoffice after this many minutes.',
6150     'type'       => 'text',
6151   },
6152
6153   {
6154     'key'         => 'spreadsheet_format',
6155     'section'     => 'UI',
6156     'description' => 'Default format for spreadsheet download.',
6157     'type'        => 'select',
6158     'select_hash' => [
6159       'XLS' => 'XLS (Excel 97/2000/XP)',
6160       'XLSX' => 'XLSX (Excel 2007+)',
6161     ],
6162   },
6163
6164   {
6165     'key'         => 'agent-email_day',
6166     'section'     => '',
6167     'description' => 'On this day of each month, agents with master customer records containing email addresses will be emailed a list of their customers and balances.',
6168     'type'        => 'text',
6169   },
6170
6171   {
6172     'key'         => 'report-cust_pay-select_time',
6173     'section'     => 'UI',
6174     'description' => 'Enable time selection on payment and refund reports.',
6175     'type'        => 'checkbox',
6176   },
6177
6178   {
6179     'key'         => 'default_credit_limit',
6180     'section'     => 'billing',
6181     'description' => 'Default customer credit limit',
6182     'type'        => 'text',
6183   },
6184
6185   {
6186     'key'         => 'api_shared_secret',
6187     'section'     => 'API',
6188     'description' => 'Shared secret for back-office API authentication',
6189     'type'        => 'text',
6190   },
6191
6192   {
6193     'key'         => 'xmlrpc_api',
6194     'section'     => 'API',
6195     'description' => 'Enable the back-office API XML-RPC server (on port 8008).',
6196     'type'        => 'checkbox',
6197   },
6198
6199 #  {
6200 #    'key'         => 'jsonrpc_api',
6201 #    'section'     => 'API',
6202 #    'description' => 'Enable the back-office API JSON-RPC server (on port 8081).',
6203 #    'type'        => 'checkbox',
6204 #  },
6205
6206   {
6207     'key'         => 'api_credit_reason',
6208     'section'     => 'API',
6209     'description' => 'Default reason for back-office API credits',
6210     'type'        => 'select-sub',
6211     #false laziness w/api_credit_reason
6212     'options_sub' => sub { require FS::Record;
6213                            require FS::reason;
6214                            my $type = qsearchs('reason_type',
6215                              { class => 'R' })
6216                               or return ();
6217                            map { $_->reasonnum => $_->reason }
6218                                FS::Record::qsearch('reason',
6219                                  { reason_type => $type->typenum }
6220                                );
6221                          },
6222     'option_sub'  => sub { require FS::Record;
6223                            require FS::reason;
6224                            my $reason = FS::Record::qsearchs(
6225                              'reason', { 'reasonnum' => shift }
6226                            );
6227                            $reason ? $reason->reason : '';
6228                          },
6229   },
6230
6231   {
6232     'key'         => 'part_pkg-term_discounts',
6233     'section'     => 'billing',
6234     'description' => 'Enable the term discounts feature.  Recommended to keep turned off unless actually using - not well optimized for large installations.',
6235     'type'        => 'checkbox',
6236   },
6237
6238   {
6239     'key'         => 'prepaid-never_renew',
6240     'section'     => 'billing',
6241     'description' => 'Prepaid packages never renew.',
6242     'type'        => 'checkbox',
6243   },
6244
6245   {
6246     'key'         => 'agent-disable_counts',
6247     'section'     => 'UI',
6248     'description' => 'On the agent browse page, disable the customer and package counts.  Typically used for very large databases when this page takes too long to render.',
6249     'type'        => 'checkbox',
6250   },
6251
6252   {
6253     'key'         => 'tollfree-country',
6254     'section'     => 'telephony',
6255     'description' => 'Country / region for toll-free recognition',
6256     'type'        => 'select',
6257     'select_hash' => [ ''   => 'NANPA (US/Canada)',
6258                        'AU' => 'Australia',
6259                        'NZ' => 'New Zealand',
6260                      ],
6261   },
6262
6263   {
6264     'key'         => 'old_fcc_report',
6265     'section'     => '',
6266     'description' => 'Use the old (pre-2014) FCC Form 477 report format.',
6267     'type'        => 'checkbox',
6268   },
6269
6270   {
6271     'key'         => 'cust_main-default_commercial',
6272     'section'     => 'UI',
6273     'description' => 'Default for new customers is commercial rather than residential.',
6274     'type'        => 'checkbox',
6275   },
6276
6277   {
6278     'key'         => 'default_appointment_length',
6279     'section'     => 'UI',
6280     'description' => 'Default appointment length, in minutes (30 minute granularity).',
6281     'type'        => 'text',
6282   },
6283
6284   { key => "apacheroot", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
6285   { key => "apachemachine", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
6286   { key => "apachemachines", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
6287   { key => "bindprimary", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
6288   { key => "bindsecondaries", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
6289   { key => "bsdshellmachines", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
6290   { key => "cyrus", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
6291   { key => "cp_app", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
6292   { key => "erpcdmachines", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
6293   { key => "icradiusmachines", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
6294   { key => "icradius_mysqldest", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
6295   { key => "icradius_mysqlsource", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
6296   { key => "icradius_secrets", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
6297   { key => "maildisablecatchall", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
6298   { key => "mxmachines", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
6299   { key => "nsmachines", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
6300   { key => "arecords", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
6301   { key => "cnamerecords", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
6302   { key => "nismachines", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
6303   { key => "qmailmachines", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
6304   { key => "radiusmachines", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
6305   { key => "sendmailconfigpath", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
6306   { key => "sendmailmachines", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
6307   { key => "sendmailrestart", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
6308   { key => "shellmachine", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
6309   { key => "shellmachine-useradd", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
6310   { key => "shellmachine-userdel", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
6311   { key => "shellmachine-usermod", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
6312   { key => "shellmachines", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
6313   { key => "radiusprepend", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
6314   { key => "textradiusprepend", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
6315   { key => "username_policy", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
6316   { key => "vpopmailmachines", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
6317   { key => "vpopmailrestart", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
6318   { key => "safe-part_pkg", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
6319   { key => "selfservice_server-quiet", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
6320   { key => "signup_server-quiet", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
6321   { key => "signup_server-email", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
6322   { key => "vonage-username", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
6323   { key => "vonage-password", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
6324   { key => "vonage-fromnumber", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
6325
6326   {
6327     'key'         => 'selfservice-db_profile',
6328     'section'     => 'development',
6329     'description' => 'Enable collection and logging of database profiling information for self-service servers.  This has significant overhead, do not leave enabled in production beyond that necessary to collect profiling data.',
6330     'type'        => 'checkbox',
6331   },
6332
6333
6334   # for internal use only; test databases should declare this option and
6335   # everyone else should pretend it doesn't exist
6336   #{
6337   #  'key'         => 'no_random_ids',
6338   #  'section'     => '',
6339   #  'description' => 'Replace random identifiers in UI code with a static string, for repeatable testing. Don\'t use in production.',
6340   #  'type'        => 'checkbox',
6341   #},
6342
6343 );
6344
6345 1;