FS/FS/Conf.pm

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