FS/FS/Conf.pm

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