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