FS/FS/Conf.pm

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