FS/FS/Conf.pm

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