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