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