FS/FS/Conf.pm

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