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