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 7', '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-trigger',
1667     'section'     => 'notification',
1668     'description' => 'When payment receipts are triggered.  Defaults to when payment is made.',
1669     'type'        => 'select',
1670     'select_hash' => [
1671                        'cust_pay'          => 'When payment is made.',
1672                        'cust_bill_pay_pkg' => 'When payment is applied.',
1673                      ],
1674     'per_agent'   => 1,
1675   },
1676
1677   {
1678     'key'         => 'refund_receipt_msgnum',
1679     'section'     => 'notification',
1680     'description' => 'Template to use for manual refund receipts.',
1681     %msg_template_options,
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 12) (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'         => 'unsuspend_balance',
1971     'section'     => 'billing',
1972     'description' => 'Enables the automatic unsuspension of suspended packages when a customer\'s balance due is at or below the specified amount after a payment or credit',
1973     'type'        => 'select',
1974     'select_enum' => [
1975       '', 'Zero', 'Latest invoice charges'
1976     ],
1977   },
1978
1979   {
1980     'key'         => 'unsuspend-always_adjust_next_bill_date',
1981     'section'     => 'billing',
1982     '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.',
1983     'type'        => 'checkbox',
1984   },
1985
1986   {
1987     'key'         => 'usernamemin',
1988     'section'     => 'username',
1989     'description' => 'Minimum username length (default 2)',
1990     'type'        => 'text',
1991   },
1992
1993   {
1994     'key'         => 'usernamemax',
1995     'section'     => 'username',
1996     'description' => 'Maximum username length',
1997     'type'        => 'text',
1998   },
1999
2000   {
2001     'key'         => 'username-ampersand',
2002     'section'     => 'username',
2003     '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.',
2004     'type'        => 'checkbox',
2005   },
2006
2007   {
2008     'key'         => 'username-letter',
2009     'section'     => 'username',
2010     'description' => 'Usernames must contain at least one letter',
2011     'type'        => 'checkbox',
2012     'per_agent'   => 1,
2013   },
2014
2015   {
2016     'key'         => 'username-letterfirst',
2017     'section'     => 'username',
2018     'description' => 'Usernames must start with a letter',
2019     'type'        => 'checkbox',
2020   },
2021
2022   {
2023     'key'         => 'username-noperiod',
2024     'section'     => 'username',
2025     'description' => 'Disallow periods in usernames',
2026     'type'        => 'checkbox',
2027   },
2028
2029   {
2030     'key'         => 'username-nounderscore',
2031     'section'     => 'username',
2032     'description' => 'Disallow underscores in usernames',
2033     'type'        => 'checkbox',
2034   },
2035
2036   {
2037     'key'         => 'username-nodash',
2038     'section'     => 'username',
2039     'description' => 'Disallow dashes in usernames',
2040     'type'        => 'checkbox',
2041   },
2042
2043   {
2044     'key'         => 'username-uppercase',
2045     'section'     => 'username',
2046     'description' => 'Allow uppercase characters in usernames.  Not recommended for use with FreeRADIUS with MySQL backend, which is case-insensitive by default.',
2047     'type'        => 'checkbox',
2048     'per_agent'   => 1,
2049   },
2050
2051   {
2052     'key'         => 'username-percent',
2053     'section'     => 'username',
2054     'description' => 'Allow the percent character (%) in usernames.',
2055     'type'        => 'checkbox',
2056   },
2057
2058   {
2059     'key'         => 'username-colon',
2060     'section'     => 'username',
2061     'description' => 'Allow the colon character (:) in usernames.',
2062     'type'        => 'checkbox',
2063   },
2064
2065   {
2066     'key'         => 'username-slash',
2067     'section'     => 'username',
2068     '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.',
2069     'type'        => 'checkbox',
2070   },
2071
2072   {
2073     'key'         => 'username-equals',
2074     'section'     => 'username',
2075     'description' => 'Allow the equal sign character (=) in usernames.',
2076     'type'        => 'checkbox',
2077   },
2078
2079   {
2080     'key'         => 'show_ship_company',
2081     'section'     => 'UI',
2082     'description' => 'Turns on display/collection of a "service company name" field for customers.',
2083     'type'        => 'checkbox',
2084   },
2085
2086   {
2087     'key'         => 'show_ss',
2088     'section'     => 'UI',
2089     'description' => 'Turns on display/collection of social security numbers in the web interface.  Sometimes required by electronic check (ACH) processors.',
2090     'type'        => 'checkbox',
2091   },
2092
2093   {
2094     'key'         => 'unmask_ss',
2095     'section'     => 'UI',
2096     'description' => "Don't mask social security numbers in the web interface.",
2097     'type'        => 'checkbox',
2098   },
2099
2100   {
2101     'key'         => 'show_stateid',
2102     'section'     => 'UI',
2103     'description' => "Turns on display/collection of driver's license/state issued id numbers in the web interface.  Sometimes required by electronic check (ACH) processors.",
2104     'type'        => 'checkbox',
2105   },
2106
2107   {
2108     'key'         => 'national_id-country',
2109     'section'     => 'UI',
2110     'description' => 'Track a national identification number, for specific countries.',
2111     'type'        => 'select',
2112     'select_enum' => [ '', 'MY' ],
2113   },
2114
2115   {
2116     'key'         => 'show_bankstate',
2117     'section'     => 'UI',
2118     'description' => "Turns on display/collection of state for bank accounts in the web interface.  Sometimes required by electronic check (ACH) processors.",
2119     'type'        => 'checkbox',
2120   },
2121
2122   {
2123     'key'         => 'agent_defaultpkg',
2124     'section'     => 'UI',
2125     'description' => 'Setting this option will cause new packages to be available to all agent types by default.',
2126     'type'        => 'checkbox',
2127   },
2128
2129   {
2130     'key'         => 'legacy_link',
2131     'section'     => 'UI',
2132     'description' => 'Display options in the web interface to link legacy pre-Freeside services.',
2133     'type'        => 'checkbox',
2134   },
2135
2136   {
2137     'key'         => 'legacy_link-steal',
2138     'section'     => 'UI',
2139     'description' => 'Allow "stealing" an already-audited service from one customer (or package) to another using the link function.',
2140     'type'        => 'checkbox',
2141   },
2142
2143   {
2144     'key'         => 'queue_dangerous_controls',
2145     'section'     => 'UI',
2146     '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.',
2147     'type'        => 'checkbox',
2148   },
2149
2150   {
2151     'key'         => 'security_phrase',
2152     'section'     => 'password',
2153     'description' => 'Enable the tracking of a "security phrase" with each account.  Not recommended, as it is vulnerable to social engineering.',
2154     'type'        => 'checkbox',
2155   },
2156
2157   {
2158     'key'         => 'locale',
2159     'section'     => 'UI',
2160     'description' => 'Default locale',
2161     'type'        => 'select-sub',
2162     'options_sub' => sub {
2163       map { $_ => FS::Locales->description($_) } FS::Locales->locales;
2164     },
2165     'option_sub'  => sub {
2166       FS::Locales->description(shift)
2167     },
2168   },
2169
2170   {
2171     'key'         => 'signup_server-payby',
2172     'section'     => 'self-service',
2173     'description' => 'Acceptable payment types for the signup server',
2174     'type'        => 'selectmultiple',
2175     'select_enum' => [ qw(CARD DCRD CHEK DCHK PREPAY PPAL ) ], # BILL COMP) ],
2176   },
2177
2178   {
2179     'key'         => 'selfservice-payment_gateway',
2180     'section'     => 'self-service',
2181     'description' => 'Force the use of this payment gateway for self-service.',
2182     %payment_gateway_options,
2183   },
2184
2185   {
2186     'key'         => 'selfservice-save_unchecked',
2187     'section'     => 'self-service',
2188     'description' => 'In self-service, uncheck "Remember information" checkboxes by default (normally, they are checked by default).',
2189     'type'        => 'checkbox',
2190   },
2191
2192   {
2193     'key'         => 'default_agentnum',
2194     'section'     => 'UI',
2195     'description' => 'Default agent for the backoffice',
2196     'type'        => 'select-agent',
2197   },
2198
2199   {
2200     'key'         => 'signup_server-default_agentnum',
2201     'section'     => 'self-service',
2202     'description' => 'Default agent for the signup server',
2203     'type'        => 'select-agent',
2204   },
2205
2206   {
2207     'key'         => 'signup_server-default_refnum',
2208     'section'     => 'self-service',
2209     'description' => 'Default advertising source for the signup server',
2210     'type'        => 'select-sub',
2211     'options_sub' => sub { require FS::Record;
2212                            require FS::part_referral;
2213                            map { $_->refnum => $_->referral }
2214                                FS::Record::qsearch( 'part_referral',
2215                                                     { 'disabled' => '' }
2216                                                   );
2217                          },
2218     'option_sub'  => sub { require FS::Record;
2219                            require FS::part_referral;
2220                            my $part_referral = FS::Record::qsearchs(
2221                              'part_referral', { 'refnum'=>shift } );
2222                            $part_referral ? $part_referral->referral : '';
2223                          },
2224   },
2225
2226   {
2227     'key'         => 'signup_server-default_pkgpart',
2228     'section'     => 'self-service',
2229     'description' => 'Default package for the signup server',
2230     'type'        => 'select-part_pkg',
2231   },
2232
2233   {
2234     'key'         => 'signup_server-default_svcpart',
2235     'section'     => 'self-service',
2236     'description' => 'Default service definition for the signup server - only necessary for services that trigger special provisioning widgets (such as DID provisioning or domain selection).',
2237     'type'        => 'select-part_svc',
2238   },
2239
2240   {
2241     'key'         => 'signup_server-default_domsvc',
2242     'section'     => 'self-service',
2243     'description' => 'If specified, the default domain svcpart for signup (useful when domain is set to selectable choice).',
2244     'type'        => 'text',
2245   },
2246
2247   {
2248     'key'         => 'signup_server-mac_addr_svcparts',
2249     'section'     => 'self-service',
2250     'description' => 'Service definitions which can receive mac addresses (current mapped to username for svc_acct).',
2251     'type'        => 'select-part_svc',
2252     'multiple'    => 1,
2253   },
2254
2255   {
2256     'key'         => 'signup_server-nomadix',
2257     'section'     => 'self-service',
2258     'description' => 'Signup page Nomadix integration',
2259     'type'        => 'checkbox',
2260   },
2261
2262   {
2263     'key'         => 'signup_server-service',
2264     'section'     => 'self-service',
2265     'description' => 'Service for the signup server - "Account (svc_acct)" is the default setting, or "Phone number (svc_phone)" for ITSP signup',
2266     'type'        => 'select',
2267     'select_hash' => [
2268                        'svc_acct'  => 'Account (svc_acct)',
2269                        'svc_phone' => 'Phone number (svc_phone)',
2270                        'svc_pbx'   => 'PBX (svc_pbx)',
2271                        'none'      => 'None - package only',
2272                      ],
2273   },
2274
2275   {
2276     'key'         => 'signup_server-prepaid-template-custnum',
2277     'section'     => 'self-service',
2278     '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',
2279     'type'        => 'text',
2280   },
2281
2282   {
2283     'key'         => 'signup_server-terms_of_service',
2284     'section'     => 'self-service',
2285     'description' => 'Terms of Service for the signup server.  May contain HTML.',
2286     'type'        => 'textarea',
2287     'per_agent'   => 1,
2288   },
2289
2290   {
2291     'key'         => 'selfservice_server-base_url',
2292     'section'     => 'self-service',
2293     '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.',
2294     'type'        => 'text',
2295   },
2296
2297   {
2298     'key'         => 'show-msgcat-codes',
2299     'section'     => 'UI',
2300     'description' => 'Show msgcat codes in error messages.  Turn this option on before reporting errors to the mailing list.',
2301     'type'        => 'checkbox',
2302   },
2303
2304   {
2305     'key'         => 'signup_server-realtime',
2306     'section'     => 'self-service',
2307     'description' => 'Run billing for signup server signups immediately, and do not provision accounts which subsequently have a balance.',
2308     'type'        => 'checkbox',
2309   },
2310
2311   {
2312     'key'         => 'signup_server-classnum2',
2313     'section'     => 'self-service',
2314     'description' => 'Package Class for first optional purchase',
2315     'type'        => 'select-pkg_class',
2316   },
2317
2318   {
2319     'key'         => 'signup_server-classnum3',
2320     'section'     => 'self-service',
2321     'description' => 'Package Class for second optional purchase',
2322     'type'        => 'select-pkg_class',
2323   },
2324
2325   {
2326     'key'         => 'signup_server-third_party_as_card',
2327     'section'     => 'self-service',
2328     'description' => 'Allow customer payment type to be set to CARD even when using third-party credit card billing.',
2329     'type'        => 'checkbox',
2330   },
2331
2332   {
2333     'key'         => 'selfservice-xmlrpc',
2334     'section'     => 'self-service',
2335     'description' => 'Run a standalone self-service XML-RPC server on the backend (on port 8080).',
2336     'type'        => 'checkbox',
2337   },
2338
2339   {
2340     'key'         => 'selfservice-timeout',
2341     'section'     => 'self-service',
2342     'description' => 'Timeout for the self-service login cookie, in seconds.  Defaults to 1 hour.',
2343     'type'        => 'text',
2344   },
2345
2346   {
2347     'key'         => 'backend-realtime',
2348     'section'     => 'billing',
2349     'description' => 'Run billing for backend signups immediately.',
2350     'type'        => 'checkbox',
2351   },
2352
2353   {
2354     'key'         => 'decline_msgnum',
2355     'section'     => 'notification',
2356     'description' => 'Template to use for credit card and electronic check decline messages.',
2357     %msg_template_options,
2358   },
2359
2360   {
2361     'key'         => 'emaildecline',
2362     'section'     => 'notification',
2363     'description' => 'Enable emailing of credit card and electronic check decline notices.',
2364     'type'        => 'checkbox',
2365     'per_agent'   => 1,
2366   },
2367
2368   {
2369     'key'         => 'emaildecline-exclude',
2370     'section'     => 'notification',
2371     'description' => 'List of error messages that should not trigger email decline notices, one per line.',
2372     'type'        => 'textarea',
2373     'per_agent'   => 1,
2374   },
2375
2376   {
2377     'key'         => 'cancel_msgnum',
2378     'section'     => 'notification',
2379     'description' => 'Template to use for cancellation emails.',
2380     %msg_template_options,
2381   },
2382
2383   {
2384     'key'         => 'emailcancel',
2385     'section'     => 'notification',
2386     'description' => 'Enable emailing of cancellation notices.  Make sure to select the template in the cancel_msgnum option.',
2387     'type'        => 'checkbox',
2388     'per_agent'   => 1,
2389   },
2390
2391   {
2392     'key'         => 'bill_usage_on_cancel',
2393     'section'     => 'billing',
2394     '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.',
2395     'type'        => 'checkbox',
2396   },
2397
2398   {
2399     'key'         => 'require_cardname',
2400     'section'     => 'billing',
2401     'description' => 'Require an "Exact name on card" to be entered explicitly; don\'t default to using the first and last name.',
2402     'type'        => 'checkbox',
2403   },
2404
2405   {
2406     'key'         => 'enable_taxclasses',
2407     'section'     => 'taxation',
2408     'description' => 'Enable per-package tax classes',
2409     'type'        => 'checkbox',
2410   },
2411
2412   {
2413     'key'         => 'require_taxclasses',
2414     'section'     => 'taxation',
2415     'description' => 'Require a taxclass to be entered for every package',
2416     'type'        => 'checkbox',
2417   },
2418
2419   {
2420     'key'         => 'tax_data_vendor',
2421     'section'     => 'taxation',
2422     'description' => 'Tax data vendor you are using.',
2423     'type'        => 'select',
2424     'select_enum' => [ '', 'cch', 'billsoft', 'avalara', 'suretax' ],
2425   },
2426
2427   {
2428     'key'         => 'taxdatadirectdownload',
2429     'section'     => 'taxation',
2430     'description' => 'Enable downloading tax data directly from CCH. at least three lines: URL, username, and password.j',
2431     'type'        => 'textarea',
2432   },
2433
2434   {
2435     'key'         => 'ignore_incalculable_taxes',
2436     'section'     => 'taxation',
2437     'description' => 'Prefer to invoice without tax over not billing at all',
2438     'type'        => 'checkbox',
2439   },
2440
2441   {
2442     'key'         => 'billsoft-company_code',
2443     'section'     => 'taxation',
2444     'description' => 'Billsoft tax service company code (3 letters)',
2445     'type'        => 'text',
2446   },
2447
2448   {
2449     'key'         => 'avalara-taxconfig',
2450     'section'     => 'taxation',
2451     'description' => 'Avalara tax service configuration. Four lines: company code, account number, license key, test mode (1 to enable).',
2452     'type'        => 'textarea',
2453   },
2454
2455   {
2456     'key'         => 'suretax-hostname',
2457     'section'     => 'taxation',
2458     'description' => 'SureTax server name; defaults to the test server.',
2459     'type'        => 'text',
2460   },
2461
2462   {
2463     'key'         => 'suretax-client_number',
2464     'section'     => 'taxation',
2465     'description' => 'SureTax tax service client ID.',
2466     'type'        => 'text',
2467   },
2468   {
2469     'key'         => 'suretax-validation_key',
2470     'section'     => 'taxation',
2471     'description' => 'SureTax validation key (UUID).',
2472     'type'        => 'text',
2473   },
2474   {
2475     'key'         => 'suretax-business_unit',
2476     'section'     => 'taxation',
2477     'description' => 'SureTax client business unit name; optional.',
2478     'type'        => 'text',
2479     'per_agent'   => 1,
2480   },
2481   {
2482     'key'         => 'suretax-regulatory_code',
2483     'section'     => 'taxation',
2484     'description' => 'SureTax client regulatory status.',
2485     'type'        => 'select',
2486     'select_enum' => [ '', 'ILEC', 'IXC', 'CLEC', 'VOIP', 'ISP', 'Wireless' ],
2487     'per_agent'   => 1,
2488   },
2489
2490
2491   {
2492     'key'         => 'welcome_msgnum',
2493     'section'     => 'notification',
2494     'description' => 'Template to use for welcome messages when a svc_acct record is created.',
2495     %msg_template_options,
2496   },
2497
2498   {
2499     'key'         => 'svc_acct_welcome_exclude',
2500     'section'     => 'notification',
2501     'description' => 'A list of svc_acct services for which no welcome email is to be sent.',
2502     'type'        => 'select-part_svc',
2503     'multiple'    => 1,
2504   },
2505
2506   {
2507     'key'         => 'welcome_letter',
2508     'section'     => '',
2509     '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>',
2510     'type'        => 'textarea',
2511   },
2512
2513   {
2514     'key'         => 'threshold_warning_msgnum',
2515     'section'     => 'notification',
2516     'description' => 'Template to use for warning messages sent to the customer email invoice destination(s) when a svc_acct record has its usage drop below a threshold.  Extra substitutions available: $column, $amount, $threshold',
2517     %msg_template_options,
2518   },
2519
2520   {
2521     'key'         => 'payby',
2522     'section'     => 'billing',
2523     'description' => 'Available payment types.',
2524     'type'        => 'selectmultiple',
2525     'select_enum' => [ qw(CARD DCRD CHEK DCHK) ], #BILL CASH WEST MCRD MCHK PPAL) ],
2526   },
2527
2528   {
2529     'key'         => 'banned_pay-pad',
2530     'section'     => 'billing',
2531     '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.',
2532     'type'        => 'text',
2533   },
2534
2535   {
2536     'key'         => 'payby-default',
2537     'section'     => 'deprecated',
2538     '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.',
2539     'type'        => 'select',
2540     'select_enum' => [ '', qw(CARD DCRD CHEK DCHK BILL CASH WEST MCRD PPAL COMP HIDE) ],
2541   },
2542
2543   {
2544     'key'         => 'require_cash_deposit_info',
2545     'section'     => 'billing',
2546     'description' => 'When recording cash payments, display bank deposit information fields.',
2547     'type'        => 'checkbox',
2548   },
2549
2550   {
2551     'key'         => 'svc_acct-notes',
2552     'section'     => 'deprecated',
2553     'description' => 'Extra HTML to be displayed on the Account View screen.',
2554     'type'        => 'textarea',
2555   },
2556
2557   {
2558     'key'         => 'radius-password',
2559     'section'     => '',
2560     'description' => 'RADIUS attribute for plain-text passwords.',
2561     'type'        => 'select',
2562     'select_enum' => [ 'Password', 'User-Password', 'Cleartext-Password' ],
2563   },
2564
2565   {
2566     'key'         => 'radius-ip',
2567     'section'     => '',
2568     'description' => 'RADIUS attribute for IP addresses.',
2569     'type'        => 'select',
2570     'select_enum' => [ 'Framed-IP-Address', 'Framed-Address' ],
2571   },
2572
2573   #http://dev.coova.org/svn/coova-chilli/doc/dictionary.chillispot
2574   {
2575     'key'         => 'radius-chillispot-max',
2576     'section'     => '',
2577     'description' => 'Enable ChilliSpot (and CoovaChilli) Max attributes, specifically ChilliSpot-Max-{Input,Output,Total}-{Octets,Gigawords}.',
2578     'type'        => 'checkbox',
2579   },
2580
2581   {
2582     'key'         => 'svc_broadband-radius',
2583     'section'     => '',
2584     'description' => 'Enable RADIUS groups for broadband services.',
2585     'type'        => 'checkbox',
2586   },
2587
2588   {
2589     'key'         => 'svc_acct-alldomains',
2590     'section'     => '',
2591     '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.',
2592     'type'        => 'checkbox',
2593   },
2594
2595   {
2596     'key'         => 'dump-localdest',
2597     'section'     => '',
2598     'description' => 'Destination for local database dumps (full path)',
2599     'type'        => 'text',
2600   },
2601
2602   {
2603     'key'         => 'dump-scpdest',
2604     'section'     => '',
2605     'description' => 'Destination for scp database dumps: user@host:/path',
2606     'type'        => 'text',
2607   },
2608
2609   {
2610     'key'         => 'dump-pgpid',
2611     'section'     => '',
2612     '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.",
2613     'type'        => 'text',
2614   },
2615
2616   {
2617     'key'         => 'credit_card-recurring_billing_flag',
2618     'section'     => 'billing',
2619     '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. ',
2620     'type'        => 'select',
2621     'select_hash' => [
2622                        'actual_oncard' => 'Default/classic behavior: set the flag if a customer has actual previous charges on the card.',
2623                        'transaction_is_recur' => 'Set the flag if the transaction itself is recurring, regardless of previous charges on the card.',
2624                      ],
2625   },
2626
2627   {
2628     'key'         => 'credit_card-recurring_billing_acct_code',
2629     'section'     => 'billing',
2630     'description' => 'When the "recurring billing" flag is set, also set the "acct_code" to "rebill".  Useful for reporting purposes with supported gateways (PlugNPay, others?)',
2631     'type'        => 'checkbox',
2632   },
2633
2634   {
2635     'key'         => 'cvv-save',
2636     'section'     => 'billing',
2637     '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.',
2638     'type'        => 'selectmultiple',
2639     'select_enum' => \@card_types,
2640   },
2641
2642   {
2643     'key'         => 'signup-require_cvv',
2644     'section'     => 'self-service',
2645     'description' => 'Require CVV for credit card signup.',
2646     'type'        => 'checkbox',
2647   },
2648
2649   {
2650     'key'         => 'backoffice-require_cvv',
2651     'section'     => 'billing',
2652     'description' => 'Require CVV for manual credit card entry.',
2653     'type'        => 'checkbox',
2654   },
2655
2656   {
2657     'key'         => 'selfservice-onfile_require_cvv',
2658     'section'     => 'self-service',
2659     'description' => 'Require CVV for on-file credit card during self-service payments.',
2660     'type'        => 'checkbox',
2661   },
2662
2663   {
2664     'key'         => 'selfservice-require_cvv',
2665     'section'     => 'self-service',
2666     'description' => 'Require CVV for credit card self-service payments, except for cards on-file.',
2667     'type'        => 'checkbox',
2668   },
2669
2670   {
2671     'key'         => 'manual_process-single_invoice_amount',
2672     'section'     => 'billing',
2673     'description' => 'When entering manual credit card and ACH payments, amount will not autofill if the customer has more than one open invoice',
2674     'type'        => 'checkbox',
2675   },
2676
2677   {
2678     'key'         => 'manual_process-pkgpart',
2679     'section'     => 'billing',
2680     '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.',
2681     'type'        => 'select-part_pkg',
2682     'per_agent'   => 1,
2683   },
2684
2685   {
2686     'key'         => 'manual_process-display',
2687     'section'     => 'billing',
2688     'description' => 'When using manual_process-pkgpart, add the fee to the amount entered (default), or subtract the fee from the amount entered.',
2689     'type'        => 'select',
2690     'select_hash' => [
2691                        'add'      => 'Add fee to amount entered',
2692                        'subtract' => 'Subtract fee from amount entered',
2693                      ],
2694   },
2695
2696   {
2697     'key'         => 'manual_process-skip_first',
2698     'section'     => 'billing',
2699     'description' => "When using manual_process-pkgpart, omit the fee if it is the customer's first payment.",
2700     'type'        => 'checkbox',
2701   },
2702
2703   {
2704     'key'         => 'selfservice_immutable-package',
2705     'section'     => 'self-service',
2706     'description' => 'Disable package changes in self-service interface.',
2707     'type'        => 'checkbox',
2708     'per_agent'   => 1,
2709   },
2710
2711   {
2712     'key'         => 'selfservice_hide-usage',
2713     'section'     => 'self-service',
2714     'description' => 'Hide usage data in self-service interface.',
2715     'type'        => 'checkbox',
2716     'per_agent'   => 1,
2717   },
2718
2719   {
2720     'key'         => 'selfservice_process-pkgpart',
2721     'section'     => 'billing',
2722     '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.',
2723     'type'        => 'select-part_pkg',
2724     'per_agent'   => 1,
2725   },
2726
2727   {
2728     'key'         => 'selfservice_process-display',
2729     'section'     => 'billing',
2730     'description' => 'When using selfservice_process-pkgpart, add the fee to the amount entered (default), or subtract the fee from the amount entered.',
2731     'type'        => 'select',
2732     'select_hash' => [
2733                        'add'      => 'Add fee to amount entered',
2734                        'subtract' => 'Subtract fee from amount entered',
2735                      ],
2736   },
2737
2738   {
2739     'key'         => 'selfservice_process-skip_first',
2740     'section'     => 'billing',
2741     'description' => "When using selfservice_process-pkgpart, omit the fee if it is the customer's first payment.",
2742     'type'        => 'checkbox',
2743   },
2744
2745 #  {
2746 #    'key'         => 'auto_process-pkgpart',
2747 #    'section'     => 'billing',
2748 #    '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.',
2749 #    'type'        => 'select-part_pkg',
2750 #  },
2751 #
2752 ##  {
2753 ##    'key'         => 'auto_process-display',
2754 ##    'section'     => 'billing',
2755 ##    'description' => 'When using auto_process-pkgpart, add the fee to the amount entered (default), or subtract the fee from the amount entered.',
2756 ##    'type'        => 'select',
2757 ##    'select_hash' => [
2758 ##                       'add'      => 'Add fee to amount entered',
2759 ##                       'subtract' => 'Subtract fee from amount entered',
2760 ##                     ],
2761 ##  },
2762 #
2763 #  {
2764 #    'key'         => 'auto_process-skip_first',
2765 #    'section'     => 'billing',
2766 #    'description' => "When using auto_process-pkgpart, omit the fee if it is the customer's first payment.",
2767 #    'type'        => 'checkbox',
2768 #  },
2769
2770   {
2771     'key'         => 'allow_negative_charges',
2772     'section'     => 'billing',
2773     'description' => 'Allow negative charges.  Normally not used unless importing data from a legacy system that requires this.',
2774     'type'        => 'checkbox',
2775   },
2776   {
2777       'key'         => 'auto_unset_catchall',
2778       'section'     => '',
2779       '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.',
2780       'type'        => 'checkbox',
2781   },
2782
2783   {
2784     'key'         => 'system_usernames',
2785     'section'     => 'username',
2786     '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.',
2787     'type'        => 'textarea',
2788   },
2789
2790   {
2791     'key'         => 'cust_pkg-change_svcpart',
2792     'section'     => '',
2793     'description' => "When changing packages, move services even if svcparts don't match between old and new pacakge definitions.",
2794     'type'        => 'checkbox',
2795   },
2796
2797   {
2798     'key'         => 'cust_pkg-change_pkgpart-bill_now',
2799     'section'     => '',
2800     '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.",
2801     'type'        => 'checkbox',
2802   },
2803
2804   {
2805     'key'         => 'disable_autoreverse',
2806     'section'     => 'BIND',
2807     'description' => 'Disable automatic synchronization of reverse-ARPA entries.',
2808     'type'        => 'checkbox',
2809   },
2810
2811   {
2812     'key'         => 'svc_www-enable_subdomains',
2813     'section'     => '',
2814     'description' => 'Enable selection of specific subdomains for virtual host creation.',
2815     'type'        => 'checkbox',
2816   },
2817
2818   {
2819     'key'         => 'svc_www-usersvc_svcpart',
2820     'section'     => '',
2821     'description' => 'Allowable service definition svcparts for virtual hosts, one per line.',
2822     'type'        => 'select-part_svc',
2823     'multiple'    => 1,
2824   },
2825
2826   {
2827     'key'         => 'selfservice_server-primary_only',
2828     'section'     => 'self-service',
2829     'description' => 'Only allow primary accounts to access self-service functionality.',
2830     'type'        => 'checkbox',
2831   },
2832
2833   {
2834     'key'         => 'selfservice_server-phone_login',
2835     'section'     => 'self-service',
2836     'description' => 'Allow login to self-service with phone number and PIN.',
2837     'type'        => 'checkbox',
2838   },
2839
2840   {
2841     'key'         => 'selfservice_server-single_domain',
2842     'section'     => 'self-service',
2843     'description' => 'If specified, only use this one domain for self-service access.',
2844     'type'        => 'text',
2845   },
2846
2847   {
2848     'key'         => 'selfservice_server-login_svcpart',
2849     'section'     => 'self-service',
2850     'description' => 'If specified, only allow the specified svcparts to login to self-service.',
2851     'type'        => 'select-part_svc',
2852     'multiple'    => 1,
2853   },
2854
2855   {
2856     'key'         => 'selfservice-svc_forward_svcpart',
2857     'section'     => 'self-service',
2858     'description' => 'Service for self-service forward editing.',
2859     'type'        => 'select-part_svc',
2860   },
2861
2862   {
2863     'key'         => 'selfservice-password_reset_verification',
2864     'section'     => 'self-service',
2865     'description' => 'If enabled, specifies the type of verification required for self-service password resets.',
2866     'type'        => 'select',
2867     'select_hash' => [ '' => 'Password reset disabled',
2868                        'email' => 'Click on a link in email',
2869                        '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.',
2870                      ],
2871   },
2872
2873   {
2874     'key'         => 'selfservice-password_reset_msgnum',
2875     'section'     => 'self-service',
2876     'description' => 'Template to use for password reset emails.',
2877     %msg_template_options,
2878   },
2879
2880   {
2881     'key'         => 'selfservice-password_change_oldpass',
2882     'section'     => 'self-service',
2883     'description' => 'Require old password to be entered again for password changes (in addition to being logged in), at the API level.',
2884     'type'        => 'checkbox',
2885   },
2886
2887   {
2888     'key'         => 'selfservice-hide_invoices-taxclass',
2889     'section'     => 'self-service',
2890     '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.',
2891     'type'        => 'text',
2892   },
2893
2894   {
2895     'key'         => 'selfservice-recent-did-age',
2896     'section'     => 'self-service',
2897     'description' => 'If specified, defines "recent", in number of seconds, for "Download recently allocated DIDs" in self-service.',
2898     'type'        => 'text',
2899   },
2900
2901   {
2902     'key'         => 'selfservice_server-view-wholesale',
2903     'section'     => 'self-service',
2904     'description' => 'If enabled, use a wholesale package view in the self-service.',
2905     'type'        => 'checkbox',
2906   },
2907
2908   {
2909     'key'         => 'selfservice-agent_signup',
2910     'section'     => 'self-service',
2911     'description' => 'Allow agent signup via self-service.',
2912     'type'        => 'checkbox',
2913   },
2914
2915   {
2916     'key'         => 'selfservice-agent_signup-agent_type',
2917     'section'     => 'self-service',
2918     'description' => 'Agent type when allowing agent signup via self-service.',
2919     'type'        => 'select-sub',
2920     'options_sub' => sub { require FS::Record;
2921                            require FS::agent_type;
2922                            map { $_->typenum => $_->atype }
2923                                FS::Record::qsearch('agent_type', {} ); # disabled=>'' } );
2924                          },
2925     'option_sub'  => sub { require FS::Record;
2926                            require FS::agent_type;
2927                            my $agent_type = FS::Record::qsearchs(
2928                              'agent_type', { 'typenum'=>shift }
2929                            );
2930                            $agent_type ? $agent_type->atype : '';
2931                          },
2932   },
2933
2934   {
2935     'key'         => 'selfservice-agent_login',
2936     'section'     => 'self-service',
2937     'description' => 'Allow agent login via self-service.',
2938     'type'        => 'checkbox',
2939   },
2940
2941   {
2942     'key'         => 'selfservice-self_suspend_reason',
2943     'section'     => 'self-service',
2944     'description' => 'Suspend reason when customers suspend their own packages. Set to nothing to disallow self-suspension.',
2945     'type'        => 'select-sub',
2946     #false laziness w/api_credit_reason
2947     'options_sub' => sub { require FS::Record;
2948                            require FS::reason;
2949                            my $type = qsearchs('reason_type',
2950                              { class => 'S' })
2951                               or return ();
2952                            map { $_->reasonnum => $_->reason }
2953                                FS::Record::qsearch('reason',
2954                                  { reason_type => $type->typenum }
2955                                );
2956                          },
2957     'option_sub'  => sub { require FS::Record;
2958                            require FS::reason;
2959                            my $reason = FS::Record::qsearchs(
2960                              'reason', { 'reasonnum' => shift }
2961                            );
2962                            $reason ? $reason->reason : '';
2963                          },
2964
2965     'per_agent'   => 1,
2966   },
2967
2968   {
2969     'key'         => 'card_refund-days',
2970     'section'     => 'billing',
2971     'description' => 'After a payment, the number of days a refund link will be available for that payment.  Defaults to 120.',
2972     'type'        => 'text',
2973   },
2974
2975   {
2976     'key'         => 'agent-showpasswords',
2977     'section'     => '',
2978     'description' => 'Display unencrypted user passwords in the agent (reseller) interface',
2979     'type'        => 'checkbox',
2980   },
2981
2982   {
2983     'key'         => 'global_unique-username',
2984     'section'     => 'username',
2985     '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.',
2986     'type'        => 'select',
2987     'select_enum' => [ 'none', 'username', 'username@domain', 'disabled' ],
2988   },
2989
2990   {
2991     'key'         => 'global_unique-phonenum',
2992     'section'     => '',
2993     '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.',
2994     'type'        => 'select',
2995     'select_enum' => [ 'none', 'countrycode+phonenum', 'disabled' ],
2996   },
2997
2998   {
2999     'key'         => 'global_unique-pbx_title',
3000     'section'     => '',
3001     'description' => 'Global phone number uniqueness control: none (check uniqueness per exports), enabled (check across all services), or disabled (no duplicate checking).',
3002     'type'        => 'select',
3003     'select_enum' => [ 'enabled', 'disabled' ],
3004   },
3005
3006   {
3007     'key'         => 'global_unique-pbx_id',
3008     'section'     => '',
3009     'description' => 'Global PBX id uniqueness control: none (check uniqueness per exports), enabled (check across all services), or disabled (no duplicate checking).',
3010     'type'        => 'select',
3011     'select_enum' => [ 'enabled', 'disabled' ],
3012   },
3013
3014   {
3015     'key'         => 'svc_external-skip_manual',
3016     'section'     => 'UI',
3017     '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).',
3018     'type'        => 'checkbox',
3019   },
3020
3021   {
3022     'key'         => 'svc_external-display_type',
3023     'section'     => 'UI',
3024     'description' => 'Select a specific svc_external type to enable some UI changes specific to that type (i.e. artera_turbo).',
3025     'type'        => 'select',
3026     'select_enum' => [ 'generic', 'artera_turbo', ],
3027   },
3028
3029   {
3030     'key'         => 'ticket_system',
3031     'section'     => 'ticketing',
3032     '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).',
3033     'type'        => 'select',
3034     #'select_enum' => [ '', qw(RT_Internal RT_Libs RT_External) ],
3035     'select_enum' => [ '', qw(RT_Internal RT_External) ],
3036   },
3037
3038   {
3039     'key'         => 'network_monitoring_system',
3040     'section'     => 'network_monitoring',
3041     '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>).',
3042     'type'        => 'select',
3043     'select_enum' => [ '', qw(Torrus_Internal) ],
3044   },
3045
3046   {
3047     'key'         => 'nms-auto_add-svc_ips',
3048     'section'     => 'network_monitoring',
3049     'description' => 'Automatically add (and remove) IP addresses from these service tables to the network monitoring system.',
3050     'type'        => 'selectmultiple',
3051     'select_enum' => [ 'svc_acct', 'svc_broadband', 'svc_dsl' ],
3052   },
3053
3054   {
3055     'key'         => 'nms-auto_add-community',
3056     'section'     => 'network_monitoring',
3057     'description' => 'SNMP community string to use when automatically adding IP addresses from these services to the network monitoring system.',
3058     'type'        => 'text',
3059   },
3060
3061   {
3062     'key'         => 'ticket_system-default_queueid',
3063     'section'     => 'ticketing',
3064     'description' => 'Default queue used when creating new customer tickets.',
3065     'type'        => 'select-sub',
3066     'options_sub' => sub {
3067                            my $conf = new FS::Conf;
3068                            if ( $conf->config('ticket_system') ) {
3069                              eval "use FS::TicketSystem;";
3070                              die $@ if $@;
3071                              FS::TicketSystem->queues();
3072                            } else {
3073                              ();
3074                            }
3075                          },
3076     'option_sub'  => sub {
3077                            my $conf = new FS::Conf;
3078                            if ( $conf->config('ticket_system') ) {
3079                              eval "use FS::TicketSystem;";
3080                              die $@ if $@;
3081                              FS::TicketSystem->queue(shift);
3082                            } else {
3083                              '';
3084                            }
3085                          },
3086   },
3087
3088   {
3089     'key'         => 'ticket_system-force_default_queueid',
3090     'section'     => 'ticketing',
3091     'description' => 'Disallow queue selection when creating new tickets from customer view.',
3092     'type'        => 'checkbox',
3093   },
3094
3095   {
3096     'key'         => 'ticket_system-selfservice_queueid',
3097     'section'     => 'ticketing',
3098     'description' => 'Queue used when creating new customer tickets from self-service.  Defautls to ticket_system-default_queueid if not specified.',
3099     #false laziness w/above
3100     'type'        => 'select-sub',
3101     'options_sub' => sub {
3102                            my $conf = new FS::Conf;
3103                            if ( $conf->config('ticket_system') ) {
3104                              eval "use FS::TicketSystem;";
3105                              die $@ if $@;
3106                              FS::TicketSystem->queues();
3107                            } else {
3108                              ();
3109                            }
3110                          },
3111     'option_sub'  => sub {
3112                            my $conf = new FS::Conf;
3113                            if ( $conf->config('ticket_system') ) {
3114                              eval "use FS::TicketSystem;";
3115                              die $@ if $@;
3116                              FS::TicketSystem->queue(shift);
3117                            } else {
3118                              '';
3119                            }
3120                          },
3121   },
3122
3123   {
3124     'key'         => 'ticket_system-requestor',
3125     'section'     => 'ticketing',
3126     'description' => 'Email address to use as the requestor for new tickets.  If blank, the customer\'s invoicing address(es) will be used.',
3127     'type'        => 'text',
3128   },
3129
3130   {
3131     'key'         => 'ticket_system-priority_reverse',
3132     'section'     => 'ticketing',
3133     '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.',
3134     'type'        => 'checkbox',
3135   },
3136
3137   {
3138     'key'         => 'ticket_system-custom_priority_field',
3139     'section'     => 'ticketing',
3140     'description' => 'Custom field from the ticketing system to use as a custom priority classification.',
3141     'type'        => 'text',
3142   },
3143
3144   {
3145     'key'         => 'ticket_system-custom_priority_field-values',
3146     'section'     => 'ticketing',
3147     'description' => 'Values for the custom field from the ticketing system to break down and sort customer ticket lists.',
3148     'type'        => 'textarea',
3149   },
3150
3151   {
3152     'key'         => 'ticket_system-custom_priority_field_queue',
3153     'section'     => 'ticketing',
3154     'description' => 'Ticketing system queue in which the custom field specified in ticket_system-custom_priority_field is located.',
3155     'type'        => 'text',
3156   },
3157
3158   {
3159     'key'         => 'ticket_system-selfservice_priority_field',
3160     'section'     => 'ticketing',
3161     'description' => 'Custom field from the ticket system to use as a customer-managed priority field.',
3162     'type'        => 'text',
3163   },
3164
3165   {
3166     'key'         => 'ticket_system-selfservice_edit_subject',
3167     'section'     => 'ticketing',
3168     'description' => 'Allow customers to edit ticket subjects through selfservice.',
3169     'type'        => 'checkbox',
3170   },
3171
3172   {
3173     'key'         => 'ticket_system-appointment-queueid',
3174     'section'     => 'ticketing',
3175     'description' => 'Ticketing queue to use for appointments.',
3176     #false laziness w/above
3177     'type'        => 'select-sub',
3178     'options_sub' => sub {
3179                            my $conf = new FS::Conf;
3180                            if ( $conf->config('ticket_system') ) {
3181                              eval "use FS::TicketSystem;";
3182                              die $@ if $@;
3183                              FS::TicketSystem->queues();
3184                            } else {
3185                              ();
3186                            }
3187                          },
3188     'option_sub'  => sub {
3189                            my $conf = new FS::Conf;
3190                            if ( $conf->config('ticket_system') ) {
3191                              eval "use FS::TicketSystem;";
3192                              die $@ if $@;
3193                              FS::TicketSystem->queue(shift);
3194                            } else {
3195                              '';
3196                            }
3197                          },
3198   },
3199
3200   {
3201     'key'         => 'ticket_system-appointment-custom_field',
3202     'section'     => 'ticketing',
3203     'description' => 'Ticketing custom field to use as an appointment classification.',
3204     'type'        => 'text',
3205   },
3206
3207   {
3208     'key'         => 'ticket_system-escalation',
3209     'section'     => 'ticketing',
3210     'description' => 'Enable priority escalation of tickets as part of daily batch processing.',
3211     'type'        => 'checkbox',
3212   },
3213
3214   {
3215     'key'         => 'ticket_system-rt_external_datasrc',
3216     'section'     => 'ticketing',
3217     '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>',
3218     'type'        => 'text',
3219
3220   },
3221
3222   {
3223     'key'         => 'ticket_system-rt_external_url',
3224     'section'     => 'ticketing',
3225     'description' => 'With external RT integration, the URL for the external RT installation, for example, <code>https://rt.example.com/rt</code>',
3226     'type'        => 'text',
3227   },
3228
3229   {
3230     'key'         => 'company_name',
3231     'section'     => 'required',
3232     'description' => 'Your company name',
3233     'type'        => 'text',
3234     'per_agent'   => 1, #XXX just FS/FS/ClientAPI/Signup.pm
3235   },
3236
3237   {
3238     'key'         => 'company_url',
3239     'section'     => 'UI',
3240     'description' => 'Your company URL',
3241     'type'        => 'text',
3242     'per_agent'   => 1,
3243   },
3244
3245   {
3246     'key'         => 'company_address',
3247     'section'     => 'required',
3248     'description' => 'Your company address',
3249     'type'        => 'textarea',
3250     'per_agent'   => 1,
3251   },
3252
3253   {
3254     'key'         => 'company_phonenum',
3255     'section'     => 'notification',
3256     'description' => 'Your company phone number',
3257     'type'        => 'text',
3258     'per_agent'   => 1,
3259   },
3260
3261   {
3262     'key'         => 'address1-search',
3263     'section'     => 'UI',
3264     '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.',
3265     'type'        => 'checkbox',
3266   },
3267
3268   {
3269     'key'         => 'address2-search',
3270     'section'     => 'UI',
3271     'description' => 'Enable a "Unit" search box which searches the second address field.  Useful for multi-tenant applications.  See also: cust_main-require_address2',
3272     'type'        => 'checkbox',
3273   },
3274
3275   {
3276     'key'         => 'cust_main-require_address2',
3277     'section'     => 'UI',
3278     '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',
3279     'type'        => 'checkbox',
3280   },
3281
3282   {
3283     'key'         => 'agent-ship_address',
3284     'section'     => '',
3285     '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.",
3286     'type'        => 'checkbox',
3287     'per_agent'   => 1,
3288   },
3289
3290   { 'key'         => 'selfservice_server-cache_module',
3291     'section'     => 'self-service',
3292     '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.',
3293     'type'        => 'select',
3294     'select_enum' => [ 'Cache::SharedMemoryCache', 'Cache::FileCache', ], # '_Database' ],
3295   },
3296
3297   {
3298     'key'         => 'hylafax',
3299     'section'     => 'billing',
3300     '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).',
3301     'type'        => [qw( checkbox textarea )],
3302   },
3303
3304   {
3305     'key'         => 'cust_bill-ftpformat',
3306     'section'     => 'invoicing',
3307     'description' => 'Enable FTP of raw invoice data - format.',
3308     'type'        => 'select',
3309     'options'     => [ spool_formats() ],
3310   },
3311
3312   {
3313     'key'         => 'cust_bill-ftpserver',
3314     'section'     => 'invoicing',
3315     'description' => 'Enable FTP of raw invoice data - server.',
3316     'type'        => 'text',
3317   },
3318
3319   {
3320     'key'         => 'cust_bill-ftpusername',
3321     'section'     => 'invoicing',
3322     'description' => 'Enable FTP of raw invoice data - server.',
3323     'type'        => 'text',
3324   },
3325
3326   {
3327     'key'         => 'cust_bill-ftppassword',
3328     'section'     => 'invoicing',
3329     'description' => 'Enable FTP of raw invoice data - server.',
3330     'type'        => 'text',
3331   },
3332
3333   {
3334     'key'         => 'cust_bill-ftpdir',
3335     'section'     => 'invoicing',
3336     'description' => 'Enable FTP of raw invoice data - server.',
3337     'type'        => 'text',
3338   },
3339
3340   {
3341     'key'         => 'cust_bill-spoolformat',
3342     'section'     => 'invoicing',
3343     'description' => 'Enable spooling of raw invoice data - format.',
3344     'type'        => 'select',
3345     'options'     => [ spool_formats() ],
3346   },
3347
3348   {
3349     'key'         => 'cust_bill-spoolagent',
3350     'section'     => 'invoicing',
3351     'description' => 'Enable per-agent spooling of raw invoice data.',
3352     'type'        => 'checkbox',
3353   },
3354
3355   {
3356     'key'         => 'bridgestone-batch_counter',
3357     'section'     => '',
3358     'description' => 'Batch counter for spool files.  Increments every time a spool file is uploaded.',
3359     'type'        => 'text',
3360     'per_agent'   => 1,
3361   },
3362
3363   {
3364     'key'         => 'bridgestone-prefix',
3365     'section'     => '',
3366     'description' => 'Agent identifier for uploading to BABT printing service.',
3367     'type'        => 'text',
3368     'per_agent'   => 1,
3369   },
3370
3371   {
3372     'key'         => 'bridgestone-confirm_template',
3373     'section'     => '',
3374     '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.',
3375     # this could use a true message template, but it's hard to see how that
3376     # would make the world a better place
3377     'type'        => 'textarea',
3378     'per_agent'   => 1,
3379   },
3380
3381   {
3382     'key'         => 'ics-confirm_template',
3383     'section'     => '',
3384     'description' => 'Confirmation email template for uploading to ICS invoice printing.  Text::Template format, with variables "%count" and "%sum".',
3385     'type'        => 'textarea',
3386     'per_agent'   => 1,
3387   },
3388
3389   {
3390     'key'         => 'svc_acct-usage_suspend',
3391     'section'     => 'billing',
3392     '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.',
3393     'type'        => 'checkbox',
3394   },
3395
3396   {
3397     'key'         => 'svc_acct-usage_unsuspend',
3398     'section'     => 'billing',
3399     '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.',
3400     'type'        => 'checkbox',
3401   },
3402
3403   {
3404     'key'         => 'svc_acct-usage_threshold',
3405     'section'     => 'billing',
3406     '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.',
3407     'type'        => 'text',
3408   },
3409
3410   {
3411     'key'         => 'overlimit_groups',
3412     'section'     => '',
3413     'description' => 'RADIUS group(s) to assign to svc_acct which has exceeded its bandwidth or time limit.',
3414     'type'        => 'select-sub',
3415     'per_agent'   => 1,
3416     'multiple'    => 1,
3417     'options_sub' => sub { require FS::Record;
3418                            require FS::radius_group;
3419                            map { $_->groupnum => $_->long_description }
3420                                FS::Record::qsearch('radius_group', {} );
3421                          },
3422     'option_sub'  => sub { require FS::Record;
3423                            require FS::radius_group;
3424                            my $radius_group = FS::Record::qsearchs(
3425                              'radius_group', { 'groupnum' => shift }
3426                            );
3427                $radius_group ? $radius_group->long_description : '';
3428                          },
3429   },
3430
3431   {
3432     'key'         => 'cust-fields',
3433     'section'     => 'UI',
3434     'description' => 'Which customer fields to display on reports by default',
3435     'type'        => 'select',
3436     'select_hash' => [ FS::ConfDefaults->cust_fields_avail() ],
3437   },
3438
3439   {
3440     'key'         => 'cust_location-label_prefix',
3441     'section'     => 'UI',
3442     'description' => 'Optional "site ID" to show in the location label',
3443     'type'        => 'select',
3444     'select_hash' => [ '' => '',
3445                        'CoStAg'    => 'CoStAgXXXXX (country, state, agent name, locationnum)',
3446                        '_location' => 'Manually defined per location',
3447                       ],
3448   },
3449
3450   {
3451     'key'         => 'cust_pkg-display_times',
3452     'section'     => 'UI',
3453     'description' => 'Display full timestamps (not just dates) for customer packages.  Useful if you are doing real-time things like hourly prepaid.',
3454     'type'        => 'checkbox',
3455   },
3456
3457   {
3458     'key'         => 'cust_pkg-always_show_location',
3459     'section'     => 'UI',
3460     'description' => "Always display package locations, even when they're all the default service address.",
3461     'type'        => 'checkbox',
3462   },
3463
3464   {
3465     'key'         => 'cust_pkg-group_by_location',
3466     'section'     => 'UI',
3467     'description' => "Group packages by location.",
3468     'type'        => 'checkbox',
3469   },
3470
3471   {
3472     'key'         => 'cust_pkg-large_pkg_size',
3473     'section'     => 'UI',
3474     'description' => "In customer view, summarize packages with more than this many services.  Set to zero to never summarize packages.",
3475     'type'        => 'text',
3476   },
3477
3478   {
3479     'key'         => 'cust_pkg-hide_discontinued-part_svc',
3480     'section'     => 'UI',
3481     '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.",
3482     'type'        => 'checkbox',
3483   },
3484
3485   {
3486     'key'         => 'part_pkg-show_fcc_options',
3487     'section'     => 'UI',
3488     'description' => "Show fields on package definitions for FCC Form 477 classification",
3489     'type'        => 'checkbox',
3490   },
3491
3492   {
3493     'key'         => 'svc_acct-edit_uid',
3494     'section'     => 'shell',
3495     'description' => 'Allow UID editing.',
3496     'type'        => 'checkbox',
3497   },
3498
3499   {
3500     'key'         => 'svc_acct-edit_gid',
3501     'section'     => 'shell',
3502     'description' => 'Allow GID editing.',
3503     'type'        => 'checkbox',
3504   },
3505
3506   {
3507     'key'         => 'svc_acct-no_edit_username',
3508     'section'     => 'shell',
3509     'description' => 'Disallow username editing.',
3510     'type'        => 'checkbox',
3511   },
3512
3513   {
3514     'key'         => 'zone-underscore',
3515     'section'     => 'BIND',
3516     'description' => 'Allow underscores in zone names.  As underscores are illegal characters in zone names, this option is not recommended.',
3517     'type'        => 'checkbox',
3518   },
3519
3520   {
3521     'key'         => 'echeck-country',
3522     'section'     => 'billing',
3523     'description' => 'Format electronic check information for the specified country.',
3524     'type'        => 'select',
3525     'select_hash' => [ 'US' => 'United States',
3526                        'CA' => 'Canada (enables branch)',
3527                        'XX' => 'Other',
3528                      ],
3529   },
3530
3531   {
3532     'key'         => 'voip-cust_accountcode_cdr',
3533     'section'     => 'telephony',
3534     'description' => 'Enable the per-customer option for CDR breakdown by accountcode.',
3535     'type'        => 'checkbox',
3536   },
3537
3538   {
3539     'key'         => 'voip-cust_cdr_spools',
3540     'section'     => 'telephony',
3541     'description' => 'Enable the per-customer option for individual CDR spools.',
3542     'type'        => 'checkbox',
3543   },
3544
3545   {
3546     'key'         => 'voip-cust_cdr_squelch',
3547     'section'     => 'telephony',
3548     'description' => 'Enable the per-customer option for not printing CDR on invoices.',
3549     'type'        => 'checkbox',
3550   },
3551
3552   {
3553     'key'         => 'voip-cdr_email',
3554     'section'     => 'telephony',
3555     'description' => 'Include the call details inline on emailed invoices (and HTML invoices viewed in the backend), even if the customer is configured for not printing them on the invoices.  Useful for including these details in electronic delivery but omitting them when printing.',
3556     'type'        => 'checkbox',
3557   },
3558
3559   {
3560     'key'         => 'voip-cust_email_csv_cdr',
3561     'section'     => 'deprecated',
3562     'description' => 'Deprecated, see voip-cdr_email_attach instead.  Used to enable the per-customer option for including CDR information as a CSV attachment on emailed invoices.',
3563     'type'        => 'checkbox',
3564   },
3565
3566   {
3567     'key'         => 'voip-cdr_email_attach',
3568     'section'     => 'telephony',
3569     'description' => 'Enable the per-customer option for including CDR information as an attachment on emailed invoices.',
3570     'type'        => 'select',
3571     'select_hash' => [ ''    => 'Disabled',
3572                        'csv' => 'Text (CSV) attachment',
3573                        'zip' => 'Zip attachment',
3574                      ],
3575   },
3576
3577   {
3578     'key'         => 'cgp_rule-domain_templates',
3579     'section'     => '',
3580     'description' => 'Communigate Pro rule templates for domains, one per line, "svcnum Name"',
3581     'type'        => 'textarea',
3582   },
3583
3584   {
3585     'key'         => 'svc_forward-no_srcsvc',
3586     'section'     => '',
3587     '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.",
3588     'type'        => 'checkbox',
3589   },
3590
3591   {
3592     'key'         => 'svc_forward-arbitrary_dst',
3593     'section'     => '',
3594     '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.",
3595     'type'        => 'checkbox',
3596   },
3597
3598   {
3599     'key'         => 'tax-ship_address',
3600     'section'     => 'taxation',
3601     'description' => 'By default, tax calculations are done based on the billing address.  Enable this switch to calculate tax based on the shipping address instead.',
3602     'type'        => 'checkbox',
3603   }
3604 ,
3605   {
3606     'key'         => 'tax-pkg_address',
3607     'section'     => 'taxation',
3608     '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).',
3609     'type'        => 'checkbox',
3610   },
3611
3612   {
3613     'key'         => 'invoice-ship_address',
3614     'section'     => 'invoicing',
3615     'description' => 'Include the shipping address on invoices.',
3616     'type'        => 'checkbox',
3617   },
3618
3619   {
3620     'key'         => 'invoice-unitprice',
3621     'section'     => 'invoicing',
3622     'description' => 'Enable unit pricing on invoices and quantities on packages.',
3623     'type'        => 'checkbox',
3624   },
3625
3626   {
3627     'key'         => 'invoice-smallernotes',
3628     'section'     => 'invoicing',
3629     'description' => 'Display the notes section in a smaller font on invoices.',
3630     'type'        => 'checkbox',
3631   },
3632
3633   {
3634     'key'         => 'invoice-smallerfooter',
3635     'section'     => 'invoicing',
3636     'description' => 'Display footers in a smaller font on invoices.',
3637     'type'        => 'checkbox',
3638   },
3639
3640   {
3641     'key'         => 'postal_invoice-fee_pkgpart',
3642     'section'     => 'billing',
3643     'description' => 'This allows selection of a package to insert on invoices for customers with postal invoices selected.',
3644     'type'        => 'select-part_pkg',
3645     'per_agent'   => 1,
3646   },
3647
3648   {
3649     'key'         => 'postal_invoice-recurring_only',
3650     'section'     => 'billing',
3651     'description' => 'The postal invoice fee is omitted on invoices without recurring charges when this is set.',
3652     'type'        => 'checkbox',
3653   },
3654
3655   {
3656     'key'         => 'batch-enable',
3657     'section'     => 'deprecated', #make sure batch-enable_payby is set for
3658                                    #everyone before removing
3659     'description' => 'Enable credit card and/or ACH batching - leave disabled for real-time installations.',
3660     'type'        => 'checkbox',
3661   },
3662
3663   {
3664     'key'         => 'batch-enable_payby',
3665     'section'     => 'billing',
3666     'description' => 'Enable batch processing for the specified payment types.',
3667     'type'        => 'selectmultiple',
3668     'select_enum' => [qw( CARD CHEK )],
3669   },
3670
3671   {
3672     'key'         => 'realtime-disable_payby',
3673     'section'     => 'billing',
3674     'description' => 'Disable realtime processing for the specified payment types.',
3675     'type'        => 'selectmultiple',
3676     'select_enum' => [qw( CARD CHEK )],
3677   },
3678
3679   {
3680     'key'         => 'batch-default_format',
3681     'section'     => 'billing',
3682     'description' => 'Default format for batches.',
3683     'type'        => 'select',
3684     'select_enum' => [ 'NACHA', 'csv-td_canada_trust-merchant_pc_batch',
3685                        'csv-chase_canada-E-xactBatch', 'BoM', 'PAP',
3686                        'paymentech', 'ach-spiritone', 'RBC', 'CIBC',
3687                     ]
3688   },
3689
3690   { 'key'         => 'batch-gateway-CARD',
3691     'section'     => 'billing',
3692     'description' => 'Business::BatchPayment gateway for credit card batches.',
3693     %batch_gateway_options,
3694   },
3695
3696   { 'key'         => 'batch-gateway-CHEK',
3697     'section'     => 'billing',
3698     'description' => 'Business::BatchPayment gateway for check batches.',
3699     %batch_gateway_options,
3700   },
3701
3702   {
3703     'key'         => 'batch-reconsider',
3704     'section'     => 'billing',
3705     '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.',
3706     'type'        => 'checkbox',
3707   },
3708
3709   {
3710     'key'         => 'batch-auto_resolve_days',
3711     'section'     => 'billing',
3712     'description' => 'Automatically resolve payment batches this many days after they were first downloaded.',
3713     'type'        => 'text',
3714   },
3715
3716   {
3717     'key'         => 'batch-auto_resolve_status',
3718     'section'     => 'billing',
3719     'description' => 'When automatically resolving payment batches, take this action for payments of unknown status.',
3720     'type'        => 'select',
3721     'select_enum' => [ 'approve', 'decline' ],
3722   },
3723
3724   # replaces batch-errors_to (sent email on error)
3725   {
3726     'key'         => 'batch-errors_not_fatal',
3727     'section'     => 'billing',
3728     '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.',
3729     'type'        => 'checkbox',
3730   },
3731
3732   #lists could be auto-generated from pay_batch info
3733   {
3734     'key'         => 'batch-fixed_format-CARD',
3735     'section'     => 'billing',
3736     'description' => 'Fixed (unchangeable) format for credit card batches.',
3737     'type'        => 'select',
3738     'select_enum' => [ 'csv-td_canada_trust-merchant_pc_batch', 'BoM', 'PAP' ,
3739                        'csv-chase_canada-E-xactBatch', 'paymentech' ]
3740   },
3741
3742   {
3743     'key'         => 'batch-fixed_format-CHEK',
3744     'section'     => 'billing',
3745     'description' => 'Fixed (unchangeable) format for electronic check batches.',
3746     'type'        => 'select',
3747     'select_enum' => [ 'NACHA', 'csv-td_canada_trust-merchant_pc_batch', 'BoM',
3748                        'PAP', 'paymentech', 'ach-spiritone', 'RBC',
3749                        'td_eft1464', 'eft_canada', 'CIBC'
3750                      ]
3751   },
3752
3753   {
3754     'key'         => 'batch-increment_expiration',
3755     'section'     => 'billing',
3756     'description' => 'Increment expiration date years in batches until cards are current.  Make sure this is acceptable to your batching provider before enabling.',
3757     'type'        => 'checkbox'
3758   },
3759
3760   {
3761     'key'         => 'batchconfig-BoM',
3762     'section'     => 'billing',
3763     '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',
3764     'type'        => 'textarea',
3765   },
3766
3767 {
3768     'key'         => 'batchconfig-CIBC',
3769     'section'     => 'billing',
3770     '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',
3771     'type'        => 'textarea',
3772   },
3773
3774   {
3775     'key'         => 'batchconfig-PAP',
3776     'section'     => 'billing',
3777     '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',
3778     'type'        => 'textarea',
3779   },
3780
3781   {
3782     'key'         => 'batchconfig-csv-chase_canada-E-xactBatch',
3783     'section'     => 'billing',
3784     'description' => 'Gateway ID for Chase Canada E-xact batching',
3785     'type'        => 'text',
3786   },
3787
3788   {
3789     'key'         => 'batchconfig-paymentech',
3790     'section'     => 'billing',
3791     '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.',
3792     'type'        => 'textarea',
3793   },
3794
3795   {
3796     'key'         => 'batchconfig-RBC',
3797     'section'     => 'billing',
3798     '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.',
3799     'type'        => 'textarea',
3800   },
3801
3802   {
3803     'key'         => 'batchconfig-RBC-login',
3804     'section'     => 'billing',
3805     '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.',
3806     'type'        => 'textarea',
3807   },
3808
3809   {
3810     'key'         => 'batchconfig-td_eft1464',
3811     'section'     => 'billing',
3812     '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.',
3813     'type'        => 'textarea',
3814   },
3815
3816   {
3817     'key'         => 'batchconfig-eft_canada',
3818     'section'     => 'billing',
3819     '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.',
3820     'type'        => 'textarea',
3821     'per_agent'   => 1,
3822   },
3823
3824   {
3825     'key'         => 'batchconfig-nacha-destination',
3826     'section'     => 'billing',
3827     'description' => 'Configuration for NACHA batching, Destination (9 digit transit routing number).',
3828     'type'        => 'text',
3829   },
3830
3831   {
3832     'key'         => 'batchconfig-nacha-destination_name',
3833     'section'     => 'billing',
3834     'description' => 'Configuration for NACHA batching, Destination (Bank Name, up to 23 characters).',
3835     'type'        => 'text',
3836   },
3837
3838   {
3839     'key'         => 'batchconfig-nacha-origin',
3840     'section'     => 'billing',
3841     'description' => 'Configuration for NACHA batching, Origin (your 10-digit company number, IRS tax ID recommended).',
3842     'type'        => 'text',
3843   },
3844
3845   {
3846     'key'         => 'batchconfig-nacha-origin_name',
3847     'section'     => 'billing',
3848     'description' => 'Configuration for NACHA batching, Origin name (defaults to company name, but sometimes bank name is needed instead.)',
3849     'type'        => 'text',
3850   },
3851
3852   {
3853     'key'         => 'batch-manual_approval',
3854     'section'     => 'billing',
3855     '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.',
3856     'type'        => 'checkbox',
3857   },
3858
3859   {
3860     'key'         => 'batch-spoolagent',
3861     'section'     => 'billing',
3862     'description' => 'Store payment batches per-agent.',
3863     'type'        => 'checkbox',
3864   },
3865
3866   {
3867     'key'         => 'payment_history-years',
3868     'section'     => 'UI',
3869     'description' => 'Number of years of payment history to show by default.  Currently defaults to 2.',
3870     'type'        => 'text',
3871   },
3872
3873   {
3874     'key'         => 'change_history-years',
3875     'section'     => 'UI',
3876     'description' => 'Number of years of change history to show by default.  Currently defaults to 0.5.',
3877     'type'        => 'text',
3878   },
3879
3880   {
3881     'key'         => 'cust_main-packages-years',
3882     'section'     => 'UI',
3883     'description' => 'Number of years to show old (cancelled and one-time charge) packages by default.  Currently defaults to 2.',
3884     'type'        => 'text',
3885   },
3886
3887   {
3888     'key'         => 'cust_main-use_comments',
3889     'section'     => 'UI',
3890     'description' => 'Display free form comments on the customer edit screen.  Useful as a scratch pad.',
3891     'type'        => 'checkbox',
3892   },
3893
3894   {
3895     'key'         => 'cust_main-disable_notes',
3896     'section'     => 'UI',
3897     'description' => 'Disable new style customer notes - timestamped and user identified customer notes.  Useful in tracking who did what.',
3898     'type'        => 'checkbox',
3899   },
3900
3901   {
3902     'key'         => 'cust_main_note-display_times',
3903     'section'     => 'UI',
3904     'description' => 'Display full timestamps (not just dates) for customer notes.',
3905     'type'        => 'checkbox',
3906   },
3907
3908   {
3909     'key'         => 'cust_main-ticket_statuses',
3910     'section'     => 'UI',
3911     'description' => 'Show tickets with these statuses on the customer view page.',
3912     'type'        => 'selectmultiple',
3913     'select_enum' => [qw( new open stalled resolved rejected deleted )],
3914   },
3915
3916   {
3917     'key'         => 'cust_main-max_tickets',
3918     'section'     => 'UI',
3919     'description' => 'Maximum number of tickets to show on the customer view page.',
3920     'type'        => 'text',
3921   },
3922
3923   {
3924     'key'         => 'cust_main-enable_birthdate',
3925     'section'     => 'UI',
3926     'description' => 'Enable tracking of a birth date with each customer record',
3927     'type'        => 'checkbox',
3928   },
3929
3930   {
3931     'key'         => 'cust_main-enable_spouse',
3932     'section'     => 'UI',
3933     'description' => 'Enable tracking of a spouse\'s name and date of birth with each customer record',
3934     'type'        => 'checkbox',
3935   },
3936
3937   {
3938     'key'         => 'cust_main-enable_anniversary_date',
3939     'section'     => 'UI',
3940     'description' => 'Enable tracking of an anniversary date with each customer record',
3941     'type'        => 'checkbox',
3942   },
3943
3944   {
3945     'key'         => 'cust_main-edit_calling_list_exempt',
3946     'section'     => 'UI',
3947     'description' => 'Display the "calling_list_exempt" checkbox on customer edit.',
3948     'type'        => 'checkbox',
3949   },
3950
3951   {
3952     'key'         => 'support-key',
3953     'section'     => '',
3954     '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.',
3955     'type'        => 'text',
3956   },
3957
3958   {
3959     'key'         => 'card-types',
3960     'section'     => 'billing',
3961     'description' => 'Select one or more card types to enable only those card types.  If no card types are selected, all card types are available.',
3962     'type'        => 'selectmultiple',
3963     'select_enum' => \@card_types,
3964   },
3965
3966   {
3967     'key'         => 'disable-fuzzy',
3968     'section'     => 'UI',
3969     'description' => 'Disable fuzzy searching.  Speeds up searching for large sites, but only shows exact matches.',
3970     'type'        => 'checkbox',
3971   },
3972
3973   {
3974     'key'         => 'fuzzy-fuzziness',
3975     'section'     => 'UI',
3976     'description' => 'Set the "fuzziness" of fuzzy searching (see the String::Approx manpage for details).  Defaults to 10%',
3977     'type'        => 'text',
3978   },
3979
3980   { 'key'         => 'pkg_referral',
3981     'section'     => '',
3982     'description' => 'Enable package-specific advertising sources.',
3983     'type'        => 'checkbox',
3984   },
3985
3986   { 'key'         => 'pkg_referral-multiple',
3987     'section'     => '',
3988     'description' => 'In addition, allow multiple advertising sources to be associated with a single package.',
3989     'type'        => 'checkbox',
3990   },
3991
3992   {
3993     'key'         => 'dashboard-install_welcome',
3994     'section'     => 'UI',
3995     'description' => 'New install welcome screen.',
3996     'type'        => 'select',
3997     'select_enum' => [ '', 'ITSP_fsinc_hosted', ],
3998   },
3999
4000   {
4001     'key'         => 'dashboard-toplist',
4002     'section'     => 'UI',
4003     'description' => 'List of items to display on the top of the front page',
4004     'type'        => 'textarea',
4005   },
4006
4007   {
4008     'key'         => 'impending_recur_msgnum',
4009     'section'     => 'notification',
4010     'description' => 'Template to use for alerts about first-time recurring billing.',
4011     %msg_template_options,
4012   },
4013
4014   {
4015     'key'         => 'logo.png',
4016     'section'     => 'UI',  #'invoicing' ?
4017     'description' => 'Company logo for HTML invoices and the backoffice interface, in PNG format.  Suggested size somewhere near 92x62.',
4018     'type'        => 'image',
4019     'per_agent'   => 1, #XXX just view/logo.cgi, which is for the global
4020                         #old-style editor anyway...?
4021     'per_locale'  => 1,
4022   },
4023
4024   {
4025     'key'         => 'logo.eps',
4026     'section'     => 'invoicing',
4027     'description' => 'Company logo for printed and PDF invoices, in EPS format.',
4028     'type'        => 'image',
4029     'per_agent'   => 1, #XXX as above, kinda
4030     'per_locale'  => 1,
4031   },
4032
4033   {
4034     'key'         => 'selfservice-ignore_quantity',
4035     'section'     => 'self-service',
4036     'description' => 'Ignores service quantity restrictions in self-service context.  Strongly not recommended - just set your quantities correctly in the first place.',
4037     'type'        => 'checkbox',
4038   },
4039
4040   {
4041     'key'         => 'selfservice-session_timeout',
4042     'section'     => 'self-service',
4043     'description' => 'Self-service session timeout.  Defaults to 1 hour.',
4044     'type'        => 'select',
4045     'select_enum' => [ '1 hour', '2 hours', '4 hours', '8 hours', '1 day', '1 week', ],
4046   },
4047
4048   {
4049     'key'         => 'password-generated-characters',
4050     'section'     => 'password',
4051     'description' => 'Set of characters to use when generating random passwords. This must contain at least one lowercase letter, uppercase letter, digit, and punctuation mark.',
4052     'type'        => 'textarea',
4053   },
4054
4055 #  {
4056 #    'key'         => 'password-no_reuse',
4057 #    'section'     => 'password',
4058 #    'description' => 'Minimum number of password changes before a password can be reused. By default, passwords can be reused without restriction.',
4059 #    'type'        => 'text',
4060 #  },
4061 #
4062   {
4063     'key'         => 'datavolume-forcemegabytes',
4064     'section'     => 'UI',
4065     'description' => 'All data volumes are expressed in megabytes',
4066     'type'        => 'checkbox',
4067   },
4068
4069   {
4070     'key'         => 'datavolume-significantdigits',
4071     'section'     => 'UI',
4072     'description' => 'number of significant digits to use to represent data volumes',
4073     'type'        => 'text',
4074   },
4075
4076   {
4077     'key'         => 'disable_void_after',
4078     'section'     => 'billing',
4079     'description' => 'Number of seconds after which freeside won\'t attempt to VOID a payment first when performing a refund.',
4080     'type'        => 'text',
4081   },
4082
4083   {
4084     'key'         => 'disable_line_item_date_ranges',
4085     'section'     => 'billing',
4086     'description' => 'Prevent freeside from automatically generating date ranges on invoice line items.',
4087     'type'        => 'checkbox',
4088   },
4089
4090   {
4091     'key'         => 'cust_bill-line_item-date_style',
4092     'section'     => 'billing',
4093     'description' => 'Display format for line item date ranges on invoice line items.',
4094     'type'        => 'select',
4095     'select_hash' => [ ''           => 'STARTDATE-ENDDATE',
4096                        'month_of'   => 'Month of MONTHNAME',
4097                        'X_month'    => 'DATE_DESC MONTHNAME',
4098                      ],
4099     'per_agent'   => 1,
4100   },
4101
4102   {
4103     'key'         => 'cust_bill-line_item-date_style-non_monthly',
4104     'section'     => 'billing',
4105     'description' => 'If set, override cust_bill-line_item-date_style for non-monthly charges.',
4106     'type'        => 'select',
4107     'select_hash' => [ ''           => 'Default',
4108                        'start_end'  => 'STARTDATE-ENDDATE',
4109                        'month_of'   => 'Month of MONTHNAME',
4110                        'X_month'    => 'DATE_DESC MONTHNAME',
4111                      ],
4112     'per_agent'   => 1,
4113   },
4114
4115   {
4116     'key'         => 'cust_bill-line_item-date_description',
4117     'section'     => 'billing',
4118     'description' => 'Text to display for "DATE_DESC" when using cust_bill-line_item-date_style DATE_DESC MONTHNAME.',
4119     'type'        => 'text',
4120     'per_agent'   => 1,
4121   },
4122
4123   {
4124     'key'         => 'support_packages',
4125     'section'     => '',
4126     '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...
4127     'type'        => 'select-part_pkg',
4128     'multiple'    => 1,
4129   },
4130
4131   {
4132     'key'         => 'cust_main-require_phone',
4133     'section'     => '',
4134     'description' => 'Require daytime or night phone for all customer records.',
4135     'type'        => 'checkbox',
4136     'per_agent'   => 1,
4137   },
4138
4139   {
4140     'key'         => 'cust_main-require_invoicing_list_email',
4141     'section'     => '',
4142     'description' => 'Email address field is required: require at least one invoicing email address for all customer records.',
4143     'type'        => 'checkbox',
4144     'per_agent'   => 1,
4145   },
4146
4147   {
4148     'key'         => 'cust_main-check_unique',
4149     'section'     => '',
4150     'description' => 'Warn before creating a customer record where these fields duplicate another customer.',
4151     'type'        => 'select',
4152     'multiple'    => 1,
4153     'select_hash' => [
4154       'address' => 'Billing or service address',
4155     ],
4156   },
4157
4158   {
4159     'key'         => 'svc_acct-display_paid_time_remaining',
4160     'section'     => '',
4161     'description' => 'Show paid time remaining in addition to time remaining.',
4162     'type'        => 'checkbox',
4163   },
4164
4165   {
4166     'key'         => 'cancel_credit_type',
4167     'section'     => 'billing',
4168     'description' => 'The group to use for new, automatically generated credit reasons resulting from cancellation.',
4169     reason_type_options('R'),
4170   },
4171
4172   {
4173     'key'         => 'suspend_credit_type',
4174     'section'     => 'billing',
4175     'description' => 'The group to use for new, automatically generated credit reasons resulting from package suspension.',
4176     reason_type_options('R'),
4177   },
4178
4179   {
4180     'key'         => 'referral_credit_type',
4181     'section'     => 'deprecated',
4182     '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.',
4183     reason_type_options('R'),
4184   },
4185
4186   # was only used to negate invoices during signup when card was declined, now we just void
4187   {
4188     'key'         => 'signup_credit_type',
4189     'section'     => 'deprecated', #self-service?
4190     'description' => 'The group to use for new, automatically generated credit reasons resulting from signup and self-service declines.',
4191     reason_type_options('R'),
4192   },
4193
4194   {
4195     'key'         => 'prepayment_discounts-credit_type',
4196     'section'     => 'billing',
4197     'description' => 'Enables the offering of prepayment discounts and establishes the credit reason type.',
4198     reason_type_options('R'),
4199   },
4200
4201   {
4202     'key'         => 'cust_main-agent_custid-format',
4203     'section'     => '',
4204     'description' => 'Enables searching of various formatted values in cust_main.agent_custid',
4205     'type'        => 'select',
4206     'select_hash' => [
4207                        ''       => 'Numeric only',
4208                        '\d{7}'  => 'Numeric only, exactly 7 digits',
4209                        'ww?d+'  => 'Numeric with one or two letter prefix',
4210                      ],
4211   },
4212
4213   {
4214     'key'         => 'card_masking_method',
4215     'section'     => 'UI',
4216     '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.',
4217     'type'        => 'select',
4218     'select_hash' => [
4219                        ''            => '123456xxxxxx1234',
4220                        'first6last2' => '123456xxxxxxxx12',
4221                        'first4last4' => '1234xxxxxxxx1234',
4222                        'first4last2' => '1234xxxxxxxxxx12',
4223                        'first2last4' => '12xxxxxxxxxx1234',
4224                        'first2last2' => '12xxxxxxxxxxxx12',
4225                        'first0last4' => 'xxxxxxxxxxxx1234',
4226                        'first0last2' => 'xxxxxxxxxxxxxx12',
4227                      ],
4228   },
4229
4230   {
4231     'key'         => 'disable_previous_balance',
4232     'section'     => 'invoicing',
4233     'description' => 'Show new charges only; do not list previous invoices, payments, or credits on the invoice.',
4234     'type'        => 'checkbox',
4235     'per_agent'   => 1,
4236   },
4237
4238   {
4239     'key'         => 'previous_balance-exclude_from_total',
4240     'section'     => 'invoicing',
4241     'description' => 'Show separate totals for previous invoice balance and new charges. Only meaningful when invoice_sections is false.',
4242     'type'        => 'checkbox',
4243   },
4244
4245   {
4246     'key'         => 'previous_balance-text',
4247     'section'     => 'invoicing',
4248     'description' => 'Text for the label of the total previous balance, when it is shown separately. Defaults to "Previous Balance".',
4249     'type'        => 'text',
4250   },
4251
4252   {
4253     'key'         => 'previous_balance-text-total_new_charges',
4254     'section'     => 'invoicing',
4255     '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".',
4256     'type'        => 'text',
4257   },
4258
4259   {
4260     'key'         => 'previous_balance-section',
4261     'section'     => 'invoicing',
4262     'description' => 'Show previous invoice balances in a separate invoice section.  Does not require invoice_sections to be enabled.',
4263     'type'        => 'checkbox',
4264   },
4265
4266   {
4267     'key'         => 'previous_balance-summary_only',
4268     'section'     => 'invoicing',
4269     'description' => 'Only show a single line summarizing the total previous balance rather than one line per invoice.',
4270     'type'        => 'checkbox',
4271   },
4272
4273   {
4274     'key'         => 'previous_balance-show_credit',
4275     'section'     => 'invoicing',
4276     'description' => 'Show the customer\'s credit balance on invoices when applicable.',
4277     'type'        => 'checkbox',
4278   },
4279
4280   {
4281     'key'         => 'previous_balance-show_on_statements',
4282     'section'     => 'invoicing',
4283     'description' => 'Show previous invoices on statements, without itemized charges.',
4284     'type'        => 'checkbox',
4285   },
4286
4287   {
4288     'key'         => 'previous_balance-payments_since',
4289     'section'     => 'invoicing',
4290     'description' => 'Instead of showing payments (and credits) applied to the invoice, show those received since the previous invoice date.',
4291     'type'        => 'checkbox',
4292   },
4293
4294   {
4295     'key'         => 'previous_invoice_history',
4296     'section'     => 'invoicing',
4297     'description' => 'Show a month-by-month history of the customer\'s '.
4298                      'billing amounts.  This requires template '.
4299                      'modification and is currently not supported on the '.
4300                      'stock template.',
4301     'type'        => 'checkbox',
4302   },
4303
4304   {
4305     'key'         => 'balance_due_below_line',
4306     'section'     => 'invoicing',
4307     'description' => 'Place the balance due message below a line.  Only meaningful when when invoice_sections is false.',
4308     'type'        => 'checkbox',
4309   },
4310
4311   {
4312     'key'         => 'always_show_tax',
4313     'section'     => 'invoicing',
4314     'description' => 'Show a line for tax on the invoice even when the tax is zero.  Optionally provide text for the tax name to show.',
4315     'type'        => [ qw(checkbox text) ],
4316   },
4317
4318   {
4319     'key'         => 'address_standardize_method',
4320     'section'     => 'UI', #???
4321     'description' => 'Method for standardizing customer addresses.',
4322     'type'        => 'select',
4323     'select_hash' => [ '' => '',
4324                        'uscensus' => 'U.S. Census Bureau',
4325                        'usps'     => 'U.S. Postal Service',
4326                        'tomtom'   => 'TomTom',
4327                        'melissa'  => 'Melissa WebSmart',
4328                      ],
4329   },
4330
4331   {
4332     'key'         => 'usps_webtools-userid',
4333     'section'     => 'UI',
4334     '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.',
4335     'type'        => 'text',
4336   },
4337
4338   {
4339     'key'         => 'usps_webtools-password',
4340     'section'     => 'UI',
4341     '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.',
4342     'type'        => 'text',
4343   },
4344
4345   {
4346     'key'         => 'tomtom-userid',
4347     'section'     => 'UI',
4348     '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.',
4349     'type'        => 'text',
4350   },
4351
4352   {
4353     'key'         => 'melissa-userid',
4354     'section'     => 'UI', # it's really not...
4355     'description' => 'User ID for Melissa WebSmart service.  See <a href="http://www.melissadata.com/">the Melissa website</a> for access and pricing.',
4356     'type'        => 'text',
4357   },
4358
4359   {
4360     'key'         => 'melissa-enable_geocoding',
4361     'section'     => 'UI',
4362     'description' => 'Use the Melissa service for census tract and coordinate lookups.  Enable this only if your subscription includes geocoding access.',
4363     'type'        => 'checkbox',
4364   },
4365
4366   {
4367     'key'         => 'cust_main-auto_standardize_address',
4368     'section'     => 'UI',
4369     'description' => 'When using USPS web tools, automatically standardize the address without asking.',
4370     'type'        => 'checkbox',
4371   },
4372
4373   {
4374     'key'         => 'cust_main-require_censustract',
4375     'section'     => 'UI',
4376     'description' => 'Customer is required to have a census tract.  Useful for FCC form 477 reports. See also: cust_main-auto_standardize_address',
4377     'type'        => 'checkbox',
4378   },
4379
4380   {
4381     'key'         => 'cust_main-no_city_in_address',
4382     'section'     => 'UI',
4383     'description' => 'Turn off City for billing & shipping addresses',
4384     'type'        => 'checkbox',
4385   },
4386
4387   {
4388     'key'         => 'census_year',
4389     'section'     => 'UI',
4390     '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.',
4391     'type'        => 'select',
4392     'select_enum' => [ qw( 2013 2012 2011 ) ],
4393   },
4394
4395   {
4396     'key'         => 'tax_district_method',
4397     'section'     => 'taxation',
4398     'description' => 'The method to use to look up tax district codes.',
4399     'type'        => 'select',
4400     #'select_hash' => [ FS::Misc::Geo::get_district_methods() ],
4401     #after RT#13763, using FS::Misc::Geo here now causes a dependancy loop :/
4402     'select_hash' => [
4403                        ''         => '',
4404                        'wa_sales' => 'Washington sales tax',
4405                      ],
4406   },
4407
4408   {
4409     'key'         => 'company_latitude',
4410     'section'     => 'UI',
4411     'description' => 'Your company latitude (-90 through 90)',
4412     'type'        => 'text',
4413   },
4414
4415   {
4416     'key'         => 'company_longitude',
4417     'section'     => 'UI',
4418     'description' => 'Your company longitude (-180 thru 180)',
4419     'type'        => 'text',
4420   },
4421
4422   {
4423     'key'         => 'geocode_module',
4424     'section'     => '',
4425     'description' => 'Module to geocode (retrieve a latitude and longitude for) addresses',
4426     'type'        => 'select',
4427     'select_enum' => [ 'Geo::Coder::Googlev3' ],
4428   },
4429
4430   {
4431     'key'         => 'geocode-require_nw_coordinates',
4432     'section'     => 'UI',
4433     'description' => 'Require latitude and longitude in the North Western quadrant, e.g. for North American co-ordinates, etc.',
4434     'type'        => 'checkbox',
4435   },
4436
4437   {
4438     'key'         => 'disable_acl_changes',
4439     'section'     => '',
4440     'description' => 'Disable all ACL changes, for demos.',
4441     'type'        => 'checkbox',
4442   },
4443
4444   {
4445     'key'         => 'disable_settings_changes',
4446     'section'     => '',
4447     'description' => 'Disable all settings changes, for demos, except for the usernames given in the comma-separated list.',
4448     'type'        => [qw( checkbox text )],
4449   },
4450
4451   {
4452     'key'         => 'cust_main-edit_agent_custid',
4453     'section'     => 'UI',
4454     'description' => 'Enable editing of the agent_custid field.',
4455     'type'        => 'checkbox',
4456   },
4457
4458   {
4459     'key'         => 'cust_main-default_agent_custid',
4460     'section'     => 'UI',
4461     'description' => 'Display the agent_custid field when available instead of the custnum field.  Restart Apache after changing.',
4462     'type'        => 'checkbox',
4463   },
4464
4465   {
4466     'key'         => 'cust_main-title-display_custnum',
4467     'section'     => 'UI',
4468     'description' => 'Add the display_custom (agent_custid or custnum) to the title on customer view pages.',
4469     'type'        => 'checkbox',
4470   },
4471
4472   {
4473     'key'         => 'cust_bill-default_agent_invid',
4474     'section'     => 'UI',
4475     'description' => 'Display the agent_invid field when available instead of the invnum field.',
4476     'type'        => 'checkbox',
4477   },
4478
4479   {
4480     'key'         => 'cust_main-auto_agent_custid',
4481     'section'     => 'UI',
4482     'description' => 'Automatically assign an agent_custid - select format',
4483     'type'        => 'select',
4484     'select_hash' => [ '' => 'No',
4485                        '1YMMXXXXXXXX' => '1YMMXXXXXXXX',
4486                      ],
4487   },
4488
4489   {
4490     'key'         => 'cust_main-custnum-display_prefix',
4491     'section'     => 'UI',
4492     'description' => 'Prefix the customer number with this string for display purposes.',
4493     'type'        => 'text',
4494     'per_agent'   => 1,
4495   },
4496
4497   {
4498     'key'         => 'cust_main-custnum-display_length',
4499     'section'     => 'UI',
4500     'description' => 'Zero fill the customer number to this many digits for display purposes.  Restart Apache after changing.',
4501     'type'        => 'text',
4502   },
4503
4504   {
4505     'key'         => 'cust_main-default_areacode',
4506     'section'     => 'UI',
4507     'description' => 'Default area code for customers.',
4508     'type'        => 'text',
4509   },
4510
4511   {
4512     'key'         => 'order_pkg-no_start_date',
4513     'section'     => 'UI',
4514     'description' => 'Don\'t set a default start date for new packages.',
4515     'type'        => 'checkbox',
4516   },
4517
4518   {
4519     'key'         => 'part_pkg-delay_start',
4520     'section'     => '',
4521     'description' => 'Enabled "delayed start" option for packages.',
4522     'type'        => 'checkbox',
4523   },
4524
4525   {
4526     'key'         => 'part_pkg-delay_cancel-days',
4527     'section'     => '',
4528     'description' => 'Expire packages in this many days when using delay_cancel (default is 1)',
4529     'type'        => 'text',
4530     'validate'    => sub { (($_[0] =~ /^\d*$/) && (($_[0] eq '') || $_[0]))
4531                            ? 'Must specify an integer number of days'
4532                            : '' }
4533   },
4534
4535   {
4536     'key'         => 'mcp_svcpart',
4537     'section'     => '',
4538     'description' => 'Master Control Program svcpart.  Leave this blank.',
4539     'type'        => 'text', #select-part_svc
4540   },
4541
4542   {
4543     'key'         => 'cust_bill-max_same_services',
4544     'section'     => 'invoicing',
4545     '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.',
4546     'type'        => 'text',
4547   },
4548
4549   {
4550     'key'         => 'cust_bill-consolidate_services',
4551     'section'     => 'invoicing',
4552     'description' => 'Consolidate service display into fewer lines on invoices rather than one per service.',
4553     'type'        => 'checkbox',
4554   },
4555
4556   {
4557     'key'         => 'suspend_email_admin',
4558     'section'     => '',
4559     'description' => 'Destination admin email address to enable suspension notices',
4560     'type'        => 'text',
4561   },
4562
4563   {
4564     'key'         => 'unsuspend_email_admin',
4565     'section'     => '',
4566     'description' => 'Destination admin email address to enable unsuspension notices',
4567     'type'        => 'text',
4568   },
4569
4570   {
4571     'key'         => 'selfservice-head',
4572     'section'     => 'self-service',
4573     'description' => 'HTML for the HEAD section of the self-service interface, typically used for LINK stylesheet tags',
4574     'type'        => 'textarea', #htmlarea?
4575     'per_agent'   => 1,
4576   },
4577
4578
4579   {
4580     'key'         => 'selfservice-body_header',
4581     'section'     => 'self-service',
4582     'description' => 'HTML header for the self-service interface',
4583     'type'        => 'textarea', #htmlarea?
4584     'per_agent'   => 1,
4585   },
4586
4587   {
4588     'key'         => 'selfservice-body_footer',
4589     'section'     => 'self-service',
4590     'description' => 'HTML footer for the self-service interface',
4591     'type'        => 'textarea', #htmlarea?
4592     'per_agent'   => 1,
4593   },
4594
4595
4596   {
4597     'key'         => 'selfservice-body_bgcolor',
4598     'section'     => 'self-service',
4599     'description' => 'HTML background color for the self-service interface, for example, #FFFFFF',
4600     'type'        => 'text',
4601     'per_agent'   => 1,
4602   },
4603
4604   {
4605     'key'         => 'selfservice-box_bgcolor',
4606     'section'     => 'self-service',
4607     'description' => 'HTML color for self-service interface input boxes, for example, #C0C0C0',
4608     'type'        => 'text',
4609     'per_agent'   => 1,
4610   },
4611
4612   {
4613     'key'         => 'selfservice-stripe1_bgcolor',
4614     'section'     => 'self-service',
4615     'description' => 'HTML color for self-service interface lists (primary stripe), for example, #FFFFFF',
4616     'type'        => 'text',
4617     'per_agent'   => 1,
4618   },
4619
4620   {
4621     'key'         => 'selfservice-stripe2_bgcolor',
4622     'section'     => 'self-service',
4623     'description' => 'HTML color for self-service interface lists (alternate stripe), for example, #DDDDDD',
4624     'type'        => 'text',
4625     'per_agent'   => 1,
4626   },
4627
4628   {
4629     'key'         => 'selfservice-text_color',
4630     'section'     => 'self-service',
4631     'description' => 'HTML text color for the self-service interface, for example, #000000',
4632     'type'        => 'text',
4633     'per_agent'   => 1,
4634   },
4635
4636   {
4637     'key'         => 'selfservice-link_color',
4638     'section'     => 'self-service',
4639     'description' => 'HTML link color for the self-service interface, for example, #0000FF',
4640     'type'        => 'text',
4641     'per_agent'   => 1,
4642   },
4643
4644   {
4645     'key'         => 'selfservice-vlink_color',
4646     'section'     => 'self-service',
4647     'description' => 'HTML visited link color for the self-service interface, for example, #FF00FF',
4648     'type'        => 'text',
4649     'per_agent'   => 1,
4650   },
4651
4652   {
4653     'key'         => 'selfservice-hlink_color',
4654     'section'     => 'self-service',
4655     'description' => 'HTML hover link color for the self-service interface, for example, #808080',
4656     'type'        => 'text',
4657     'per_agent'   => 1,
4658   },
4659
4660   {
4661     'key'         => 'selfservice-alink_color',
4662     'section'     => 'self-service',
4663     'description' => 'HTML active (clicked) link color for the self-service interface, for example, #808080',
4664     'type'        => 'text',
4665     'per_agent'   => 1,
4666   },
4667
4668   {
4669     'key'         => 'selfservice-font',
4670     'section'     => 'self-service',
4671     'description' => 'HTML font CSS for the self-service interface, for example, 0.9em/1.5em Arial, Helvetica, Geneva, sans-serif',
4672     'type'        => 'text',
4673     'per_agent'   => 1,
4674   },
4675
4676   {
4677     'key'         => 'selfservice-no_logo',
4678     'section'     => 'self-service',
4679     'description' => 'Disable the logo in self-service',
4680     'type'        => 'checkbox',
4681     'per_agent'   => 1,
4682   },
4683
4684   {
4685     'key'         => 'selfservice-title_color',
4686     'section'     => 'self-service',
4687     'description' => 'HTML color for the self-service title, for example, #000000',
4688     'type'        => 'text',
4689     'per_agent'   => 1,
4690   },
4691
4692   {
4693     'key'         => 'selfservice-title_align',
4694     'section'     => 'self-service',
4695     'description' => 'HTML alignment for the self-service title, for example, center',
4696     'type'        => 'text',
4697     'per_agent'   => 1,
4698   },
4699   {
4700     'key'         => 'selfservice-title_size',
4701     'section'     => 'self-service',
4702     'description' => 'HTML font size for the self-service title, for example, 3',
4703     'type'        => 'text',
4704     'per_agent'   => 1,
4705   },
4706
4707   {
4708     'key'         => 'selfservice-title_left_image',
4709     'section'     => 'self-service',
4710     'description' => 'Image used for the top of the menu in the self-service interface, in PNG format.',
4711     'type'        => 'image',
4712     'per_agent'   => 1,
4713   },
4714
4715   {
4716     'key'         => 'selfservice-title_right_image',
4717     'section'     => 'self-service',
4718     'description' => 'Image used for the top of the menu in the self-service interface, in PNG format.',
4719     'type'        => 'image',
4720     'per_agent'   => 1,
4721   },
4722
4723   {
4724     'key'         => 'selfservice-menu_disable',
4725     'section'     => 'self-service',
4726     'description' => 'Disable the selected menu entries in the self-service menu',
4727     'type'        => 'selectmultiple',
4728     'select_enum' => [ #false laziness w/myaccount_menu.html
4729                        'Overview',
4730                        'Purchase',
4731                        'Purchase additional package',
4732                        'Recharge my account with a credit card',
4733                        'Recharge my account with a check',
4734                        'Recharge my account with a prepaid card',
4735                        'View my usage',
4736                        'Create a ticket',
4737                        'Setup my services',
4738                        'Change my information',
4739                        'Change billing address',
4740                        'Change service address',
4741                        'Change payment information',
4742                        'Change password(s)',
4743                        'Logout',
4744                      ],
4745     'per_agent'   => 1,
4746   },
4747
4748   {
4749     'key'         => 'selfservice-menu_skipblanks',
4750     'section'     => 'self-service',
4751     'description' => 'Skip blank (spacer) entries in the self-service menu',
4752     'type'        => 'checkbox',
4753     'per_agent'   => 1,
4754   },
4755
4756   {
4757     'key'         => 'selfservice-menu_skipheadings',
4758     'section'     => 'self-service',
4759     'description' => 'Skip the unclickable heading entries in the self-service menu',
4760     'type'        => 'checkbox',
4761     'per_agent'   => 1,
4762   },
4763
4764   {
4765     'key'         => 'selfservice-menu_bgcolor',
4766     'section'     => 'self-service',
4767     'description' => 'HTML color for the self-service menu, for example, #C0C0C0',
4768     'type'        => 'text',
4769     'per_agent'   => 1,
4770   },
4771
4772   {
4773     'key'         => 'selfservice-menu_fontsize',
4774     'section'     => 'self-service',
4775     'description' => 'HTML font size for the self-service menu, for example, -1',
4776     'type'        => 'text',
4777     'per_agent'   => 1,
4778   },
4779   {
4780     'key'         => 'selfservice-menu_nounderline',
4781     'section'     => 'self-service',
4782     'description' => 'Styles menu links in the self-service without underlining.',
4783     'type'        => 'checkbox',
4784     'per_agent'   => 1,
4785   },
4786
4787
4788   {
4789     'key'         => 'selfservice-menu_top_image',
4790     'section'     => 'self-service',
4791     'description' => 'Image used for the top of the menu in the self-service interface, in PNG format.',
4792     'type'        => 'image',
4793     'per_agent'   => 1,
4794   },
4795
4796   {
4797     'key'         => 'selfservice-menu_body_image',
4798     'section'     => 'self-service',
4799     'description' => 'Repeating image used for the body of the menu in the self-service interface, in PNG format.',
4800     'type'        => 'image',
4801     'per_agent'   => 1,
4802   },
4803
4804   {
4805     'key'         => 'selfservice-menu_bottom_image',
4806     'section'     => 'self-service',
4807     'description' => 'Image used for the bottom of the menu in the self-service interface, in PNG format.',
4808     'type'        => 'image',
4809     'per_agent'   => 1,
4810   },
4811
4812   {
4813     'key'         => 'selfservice-view_usage_nodomain',
4814     'section'     => 'self-service',
4815     'description' => 'Show usernames without their domains in "View my usage" in the self-service interface.',
4816     'type'        => 'checkbox',
4817   },
4818
4819   {
4820     'key'         => 'selfservice-login_banner_image',
4821     'section'     => 'self-service',
4822     'description' => 'Banner image shown on the login page, in PNG format.',
4823     'type'        => 'image',
4824   },
4825
4826   {
4827     'key'         => 'selfservice-login_banner_url',
4828     'section'     => 'self-service',
4829     'description' => 'Link for the login banner.',
4830     'type'        => 'text',
4831   },
4832
4833   {
4834     'key'         => 'ng_selfservice-menu',
4835     'section'     => 'self-service',
4836     '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
4837     'type'        => 'textarea',
4838   },
4839
4840   {
4841     'key'         => 'signup-no_company',
4842     'section'     => 'self-service',
4843     'description' => "Don't display a field for company name on signup.",
4844     'type'        => 'checkbox',
4845   },
4846
4847   {
4848     'key'         => 'signup-recommend_email',
4849     'section'     => 'self-service',
4850     'description' => 'Encourage the entry of an invoicing email address on signup.',
4851     'type'        => 'checkbox',
4852   },
4853
4854   {
4855     'key'         => 'signup-recommend_daytime',
4856     'section'     => 'self-service',
4857     'description' => 'Encourage the entry of a daytime phone number on signup.',
4858     'type'        => 'checkbox',
4859   },
4860
4861   {
4862     'key'         => 'signup-duplicate_cc-warn_hours',
4863     'section'     => 'self-service',
4864     'description' => 'Issue a warning if the same credit card is used for multiple signups within this many hours.',
4865     'type'        => 'text',
4866   },
4867
4868   {
4869     'key'         => 'svc_phone-radius-password',
4870     'section'     => 'telephony',
4871     'description' => 'Password when exporting svc_phone records to RADIUS',
4872     'type'        => 'select',
4873     'select_hash' => [
4874       '' => 'Use default from svc_phone-radius-default_password config',
4875       'countrycode_phonenum' => 'Phone number (with country code)',
4876     ],
4877   },
4878
4879   {
4880     'key'         => 'svc_phone-radius-default_password',
4881     'section'     => 'telephony',
4882     'description' => 'Default password when exporting svc_phone records to RADIUS',
4883     'type'        => 'text',
4884   },
4885
4886   {
4887     'key'         => 'svc_phone-allow_alpha_phonenum',
4888     'section'     => 'telephony',
4889     'description' => 'Allow letters in phone numbers.',
4890     'type'        => 'checkbox',
4891   },
4892
4893   {
4894     'key'         => 'svc_phone-domain',
4895     'section'     => 'telephony',
4896     'description' => 'Track an optional domain association with each phone service.',
4897     'type'        => 'checkbox',
4898   },
4899
4900   {
4901     'key'         => 'svc_phone-phone_name-max_length',
4902     'section'     => 'telephony',
4903     '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.',
4904     'type'        => 'text',
4905   },
4906
4907   {
4908     'key'         => 'svc_phone-random_pin',
4909     'section'     => 'telephony',
4910     'description' => 'Number of random digits to generate in the "PIN" field, if empty.',
4911     'type'        => 'text',
4912   },
4913
4914   {
4915     'key'         => 'svc_phone-lnp',
4916     'section'     => 'telephony',
4917     'description' => 'Enables Number Portability features for svc_phone',
4918     'type'        => 'checkbox',
4919   },
4920
4921   {
4922     'key'         => 'svc_phone-bulk_provision_simple',
4923     'section'     => 'telephony',
4924     'description' => 'Bulk provision phone numbers with a simple number range instead of from DID vendor orders',
4925     'type'        => 'checkbox',
4926   },
4927
4928   {
4929     'key'         => 'default_phone_countrycode',
4930     'section'     => 'telephony',
4931     'description' => 'Default countrycode',
4932     'type'        => 'text',
4933   },
4934
4935   {
4936     'key'         => 'cdr-charged_party-field',
4937     'section'     => 'telephony',
4938     'description' => 'Set the charged_party field of CDRs to this field.',
4939     'type'        => 'select-sub',
4940     'options_sub' => sub { my $fields = FS::cdr->table_info->{'fields'};
4941                            map { $_ => $fields->{$_}||$_ }
4942                            grep { $_ !~ /^(acctid|charged_party)$/ }
4943                            FS::Schema::dbdef->table('cdr')->columns;
4944                          },
4945     'option_sub'  => sub { my $f = shift;
4946                            FS::cdr->table_info->{'fields'}{$f} || $f;
4947                          },
4948   },
4949
4950   #probably deprecate in favor of cdr-charged_party-field above
4951   {
4952     'key'         => 'cdr-charged_party-accountcode',
4953     'section'     => 'telephony',
4954     'description' => 'Set the charged_party field of CDRs to the accountcode.',
4955     'type'        => 'checkbox',
4956   },
4957
4958   {
4959     'key'         => 'cdr-charged_party-accountcode-trim_leading_0s',
4960     'section'     => 'telephony',
4961     'description' => 'When setting the charged_party field of CDRs to the accountcode, trim any leading zeros.',
4962     'type'        => 'checkbox',
4963   },
4964
4965 #  {
4966 #    'key'         => 'cdr-charged_party-truncate_prefix',
4967 #    'section'     => '',
4968 #    'description' => 'If the charged_party field has this prefix, truncate it to the length in cdr-charged_party-truncate_length.',
4969 #    'type'        => 'text',
4970 #  },
4971 #
4972 #  {
4973 #    'key'         => 'cdr-charged_party-truncate_length',
4974 #    'section'     => '',
4975 #    'description' => 'If the charged_party field has the prefix in cdr-charged_party-truncate_prefix, truncate it to this length.',
4976 #    'type'        => 'text',
4977 #  },
4978
4979   {
4980     'key'         => 'cdr-charged_party_rewrite',
4981     'section'     => 'telephony',
4982     '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*.',
4983     'type'        => 'checkbox',
4984   },
4985
4986   {
4987     'key'         => 'cdr-taqua-da_rewrite',
4988     'section'     => 'telephony',
4989     '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.',
4990     'type'        => 'text',
4991   },
4992
4993   {
4994     'key'         => 'cdr-taqua-accountcode_rewrite',
4995     'section'     => 'telephony',
4996     'description' => 'For the Taqua CDR format, pull accountcodes from secondary CDRs with matching sessionNumber.',
4997     'type'        => 'checkbox',
4998   },
4999
5000   {
5001     'key'         => 'cdr-taqua-callerid_rewrite',
5002     'section'     => 'telephony',
5003     'description' => 'For the Taqua CDR format, pull Caller ID blocking information from secondary CDRs.',
5004     'type'        => 'checkbox',
5005   },
5006
5007   {
5008     'key'         => 'cdr-asterisk_australia_rewrite',
5009     'section'     => 'telephony',
5010     'description' => 'For Asterisk CDRs, assign CDR type numbers based on Australian conventions.',
5011     'type'        => 'checkbox',
5012   },
5013
5014   {
5015     'key'         => 'cdr-gsm_tap3-sender',
5016     'section'     => 'telephony',
5017     'description' => 'GSM TAP3 Sender network (5 letter code)',
5018     'type'        => 'text',
5019   },
5020
5021   {
5022     'key'         => 'cust_pkg-show_autosuspend',
5023     'section'     => 'UI',
5024     'description' => 'Show package auto-suspend dates.  Use with caution for now; can slow down customer view for large insallations.',
5025     'type'        => 'checkbox',
5026   },
5027
5028   {
5029     'key'         => 'cdr-asterisk_forward_rewrite',
5030     'section'     => 'telephony',
5031     '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").',
5032     'type'        => 'checkbox',
5033   },
5034
5035   {
5036     'key'         => 'mc-outbound_packages',
5037     'section'     => '',
5038     'description' => "Don't use this.",
5039     'type'        => 'select-part_pkg',
5040     'multiple'    => 1,
5041   },
5042
5043   {
5044     'key'         => 'disable-cust-pkg_class',
5045     'section'     => 'UI',
5046     'description' => 'Disable the two-step dropdown for selecting package class and package, and return to the classic single dropdown.',
5047     'type'        => 'checkbox',
5048   },
5049
5050   {
5051     'key'         => 'queued-max_kids',
5052     'section'     => '',
5053     'description' => 'Maximum number of queued processes.  Defaults to 10.',
5054     'type'        => 'text',
5055   },
5056
5057   {
5058     'key'         => 'queued-sleep_time',
5059     'section'     => '',
5060     '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.',
5061     'type'        => 'text',
5062   },
5063
5064   {
5065     'key'         => 'queue-no_history',
5066     'section'     => '',
5067     '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.",
5068     'type'        => 'checkbox',
5069   },
5070
5071   {
5072     'key'         => 'cancelled_cust-noevents',
5073     'section'     => 'billing',
5074     'description' => "Don't run events for cancelled customers",
5075     'type'        => 'checkbox',
5076   },
5077
5078   {
5079     'key'         => 'agent-invoice_template',
5080     'section'     => 'invoicing',
5081     'description' => 'Enable display/edit of old-style per-agent invoice template selection',
5082     'type'        => 'checkbox',
5083   },
5084
5085   {
5086     'key'         => 'svc_broadband-manage_link',
5087     'section'     => 'UI',
5088     'description' => 'URL for svc_broadband "Manage Device" link.  The following substitutions are available: $ip_addr and $mac_addr.',
5089     'type'        => 'text',
5090   },
5091
5092   {
5093     'key'         => 'svc_broadband-manage_link_text',
5094     'section'     => 'UI',
5095     'description' => 'Label for "Manage Device" link',
5096     'type'        => 'text',
5097   },
5098
5099   {
5100     'key'         => 'svc_broadband-manage_link_loc',
5101     'section'     => 'UI',
5102     'description' => 'Location for "Manage Device" link',
5103     'type'        => 'select',
5104     'select_hash' => [
5105       'bottom' => 'Near Unprovision link',
5106       'right'  => 'With export-related links',
5107     ],
5108   },
5109
5110   {
5111     'key'         => 'svc_broadband-manage_link-new_window',
5112     'section'     => 'UI',
5113     'description' => 'Open the "Manage Device" link in a new window',
5114     'type'        => 'checkbox',
5115   },
5116
5117   #more fine-grained, service def-level control could be useful eventually?
5118   {
5119     'key'         => 'svc_broadband-allow_null_ip_addr',
5120     'section'     => '',
5121     'description' => '',
5122     'type'        => 'checkbox',
5123   },
5124
5125   {
5126     'key'         => 'svc_hardware-check_mac_addr',
5127     'section'     => '', #?
5128     'description' => 'Require the "hardware address" field in hardware services to be a valid MAC address.',
5129     'type'        => 'checkbox',
5130   },
5131
5132   {
5133     'key'         => 'tax-report_groups',
5134     'section'     => '',
5135     'description' => 'List of grouping possibilities for tax names on reports, one per line, "label op value" (op can be = or !=).',
5136     'type'        => 'textarea',
5137   },
5138
5139   {
5140     'key'         => 'tax-cust_exempt-groups',
5141     'section'     => 'taxation',
5142     '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).',
5143     'type'        => 'textarea',
5144   },
5145
5146   {
5147     'key'         => 'tax-cust_exempt-groups-require_individual_nums',
5148     'section'     => 'deprecated',
5149     'description' => 'Deprecated: see tax-cust_exempt-groups-number_requirement',
5150     'type'        => 'checkbox',
5151   },
5152
5153   {
5154     'key'         => 'tax-cust_exempt-groups-num_req',
5155     'section'     => 'taxation',
5156     'description' => 'When using tax-cust_exempt-groups, control whether individual tax exemption numbers are required for exemption from different taxes.',
5157     'type'        => 'select',
5158     'select_hash' => [ ''            => 'Not required',
5159                        'residential' => 'Required for residential customers only',
5160                        'all'         => 'Required for all customers',
5161                      ],
5162   },
5163
5164   {
5165     'key'         => 'tax-round_per_line_item',
5166     'section'     => 'billing',
5167     'description' => 'Calculate tax and round to the nearest cent for each line item, rather than for the whole invoice.',
5168     'type'        => 'checkbox',
5169   },
5170
5171   {
5172     'key'         => 'cust_main-default_view',
5173     'section'     => 'UI',
5174     'description' => 'Default customer view, for users who have not selected a default view in their preferences.',
5175     'type'        => 'select',
5176     'select_hash' => [
5177       #false laziness w/view/cust_main.cgi and pref/pref.html
5178       'basics'          => 'Basics',
5179       'notes'           => 'Notes',
5180       'tickets'         => 'Tickets',
5181       'packages'        => 'Packages',
5182       'payment_history' => 'Payment History',
5183       'change_history'  => 'Change History',
5184       'jumbo'           => 'Jumbo',
5185     ],
5186   },
5187
5188   {
5189     'key'         => 'enable_tax_adjustments',
5190     'section'     => 'taxation',
5191     'description' => 'Enable the ability to add manual tax adjustments.',
5192     'type'        => 'checkbox',
5193   },
5194
5195   {
5196     'key'         => 'rt-crontool',
5197     'section'     => '',
5198     'description' => 'Enable the RT CronTool extension.',
5199     'type'        => 'checkbox',
5200   },
5201
5202   {
5203     'key'         => 'pkg-balances',
5204     'section'     => 'billing',
5205     'description' => 'Enable per-package balances.',
5206     'type'        => 'checkbox',
5207   },
5208
5209   {
5210     'key'         => 'pkg-addon_classnum',
5211     'section'     => 'billing',
5212     'description' => 'Enable the ability to restrict additional package orders based on package class.',
5213     'type'        => 'checkbox',
5214   },
5215
5216   {
5217     'key'         => 'cust_main-edit_signupdate',
5218     'section'     => 'UI',
5219     'description' => 'Enable manual editing of the signup date.',
5220     'type'        => 'checkbox',
5221   },
5222
5223   {
5224     'key'         => 'svc_acct-disable_access_number',
5225     'section'     => 'UI',
5226     'description' => 'Disable access number selection.',
5227     'type'        => 'checkbox',
5228   },
5229
5230   {
5231     'key'         => 'cust_bill_pay_pkg-manual',
5232     'section'     => 'UI',
5233     'description' => 'Allow manual application of payments to line items.',
5234     'type'        => 'checkbox',
5235   },
5236
5237   {
5238     'key'         => 'cust_credit_bill_pkg-manual',
5239     'section'     => 'UI',
5240     'description' => 'Allow manual application of credits to line items.',
5241     'type'        => 'checkbox',
5242   },
5243
5244   {
5245     'key'         => 'breakage-days',
5246     'section'     => 'billing',
5247     '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.',
5248     'type'        => 'text',
5249     'per_agent'   => 1,
5250   },
5251
5252   {
5253     'key'         => 'breakage-pkg_class',
5254     'section'     => 'billing',
5255     'description' => 'Package class to use for breakage reconciliation.',
5256     'type'        => 'select-pkg_class',
5257   },
5258
5259   {
5260     'key'         => 'disable_cron_billing',
5261     'section'     => 'billing',
5262     '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.',
5263     'type'        => 'checkbox',
5264   },
5265
5266   {
5267     'key'         => 'svc_domain-edit_domain',
5268     'section'     => '',
5269     'description' => 'Enable domain renaming',
5270     'type'        => 'checkbox',
5271   },
5272
5273   {
5274     'key'         => 'enable_legacy_prepaid_income',
5275     'section'     => '',
5276     '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.",
5277     'type'        => 'checkbox',
5278   },
5279
5280   {
5281     'key'         => 'cust_main-exports',
5282     'section'     => '',
5283     'description' => 'Export(s) to call on cust_main insert, modification and deletion.',
5284     'type'        => 'select-sub',
5285     'multiple'    => 1,
5286     'options_sub' => sub {
5287       require FS::Record;
5288       require FS::part_export;
5289       my @part_export =
5290         map { qsearch( 'part_export', {exporttype => $_ } ) }
5291           keys %{FS::part_export::export_info('cust_main')};
5292       map { $_->exportnum => $_->exporttype.' to '.$_->machine } @part_export;
5293     },
5294     'option_sub'  => sub {
5295       require FS::Record;
5296       require FS::part_export;
5297       my $part_export = FS::Record::qsearchs(
5298         'part_export', { 'exportnum' => shift }
5299       );
5300       $part_export
5301         ? $part_export->exporttype.' to '.$part_export->machine
5302         : '';
5303     },
5304   },
5305
5306   #false laziness w/above options_sub and option_sub
5307   {
5308     'key'         => 'cust_location-exports',
5309     'section'     => '',
5310     'description' => 'Export(s) to call on cust_location insert, modification and deletion.',
5311     'type'        => 'select-sub',
5312     'multiple'    => 1,
5313     'options_sub' => sub {
5314       require FS::Record;
5315       require FS::part_export;
5316       my @part_export =
5317         map { qsearch( 'part_export', {exporttype => $_ } ) }
5318           keys %{FS::part_export::export_info('cust_location')};
5319       map { $_->exportnum => $_->exporttype.' to '.$_->machine } @part_export;
5320     },
5321     'option_sub'  => sub {
5322       require FS::Record;
5323       require FS::part_export;
5324       my $part_export = FS::Record::qsearchs(
5325         'part_export', { 'exportnum' => shift }
5326       );
5327       $part_export
5328         ? $part_export->exporttype.' to '.$part_export->machine
5329         : '';
5330     },
5331   },
5332
5333   {
5334     'key'         => 'cust_tag-location',
5335     'section'     => 'UI',
5336     'description' => 'Location where customer tags are displayed.',
5337     'type'        => 'select',
5338     'select_enum' => [ 'misc_info', 'top' ],
5339   },
5340
5341   {
5342     'key'         => 'cust_main-custom_link',
5343     'section'     => 'UI',
5344     '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.',
5345     'type'        => 'textarea',
5346   },
5347
5348   {
5349     'key'         => 'cust_main-custom_content',
5350     'section'     => 'UI',
5351     '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.',
5352     'type'        => 'textarea',
5353   },
5354
5355   {
5356     'key'         => 'cust_main-custom_title',
5357     'section'     => 'UI',
5358     'description' => 'Title for the "Custom" tab in the View Customer page.',
5359     'type'        => 'text',
5360   },
5361
5362   {
5363     'key'         => 'part_pkg-default_suspend_bill',
5364     'section'     => 'billing',
5365     'description' => 'Default the "Continue recurring billing while suspended" flag to on for new package definitions.',
5366     'type'        => 'checkbox',
5367   },
5368
5369   {
5370     'key'         => 'qual-alt_address_format',
5371     'section'     => 'UI',
5372     'description' => 'Enable the alternate address format (location type, number, and kind) for qualifications.',
5373     'type'        => 'checkbox',
5374   },
5375
5376   {
5377     'key'         => 'prospect_main-alt_address_format',
5378     'section'     => 'UI',
5379     '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.',
5380     'type'        => 'checkbox',
5381   },
5382
5383   {
5384     'key'         => 'prospect_main-location_required',
5385     'section'     => 'UI',
5386     'description' => 'Require an address for prospects.  Recommended if the main use of propects is for qualifications.',
5387     'type'        => 'checkbox',
5388   },
5389
5390   {
5391     'key'         => 'note-classes',
5392     'section'     => 'UI',
5393     'description' => 'Use customer note classes',
5394     'type'        => 'select',
5395     'select_hash' => [
5396                        0 => 'Disabled',
5397                        1 => 'Enabled',
5398                        2 => 'Enabled, with tabs',
5399                      ],
5400   },
5401
5402   {
5403     'key'         => 'svc_acct-cf_privatekey-message',
5404     'section'     => '',
5405     'description' => 'For internal use: HTML displayed when cf_privatekey field is set.',
5406     'type'        => 'textarea',
5407   },
5408
5409   {
5410     'key'         => 'menu-prepend_links',
5411     'section'     => 'UI',
5412     'description' => 'Links to prepend to the main menu, one per line, with format "URL Link Label (optional ALT popup)".',
5413     'type'        => 'textarea',
5414   },
5415
5416   {
5417     'key'         => 'cust_main-external_links',
5418     'section'     => 'UI',
5419     'description' => 'External links available in customer view, one per line, with format "URL Link Label (optional ALT popup)".  The URL will have custnum appended.',
5420     'type'        => 'textarea',
5421   },
5422
5423   {
5424     'key'         => 'svc_phone-did-summary',
5425     'section'     => 'invoicing',
5426     '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.',
5427     'type'        => 'checkbox',
5428   },
5429
5430   {
5431     'key'         => 'svc_acct-usage_seconds',
5432     'section'     => 'invoicing',
5433     'description' => 'Enable calculation of RADIUS usage time for invoices.  You must modify your template to display this information.',
5434     'type'        => 'checkbox',
5435   },
5436
5437   {
5438     'key'         => 'opensips_gwlist',
5439     'section'     => 'telephony',
5440     'description' => 'For svc_phone OpenSIPS dr_rules export, gwlist column value, per-agent',
5441     'type'        => 'text',
5442     'per_agent'   => 1,
5443     'agentonly'   => 1,
5444   },
5445
5446   {
5447     'key'         => 'opensips_description',
5448     'section'     => 'telephony',
5449     'description' => 'For svc_phone OpenSIPS dr_rules export, description column value, per-agent',
5450     'type'        => 'text',
5451     'per_agent'   => 1,
5452     'agentonly'   => 1,
5453   },
5454
5455   {
5456     'key'         => 'opensips_route',
5457     'section'     => 'telephony',
5458     'description' => 'For svc_phone OpenSIPS dr_rules export, routeid column value, per-agent',
5459     'type'        => 'text',
5460     'per_agent'   => 1,
5461     'agentonly'   => 1,
5462   },
5463
5464   {
5465     'key'         => 'cust_bill-no_recipients-error',
5466     'section'     => 'invoicing',
5467     '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.',
5468     'type'        => 'checkbox',
5469   },
5470
5471   {
5472     'key'         => 'cust_bill-latex_lineitem_maxlength',
5473     'section'     => 'invoicing',
5474     'description' => 'Truncate long line items to this number of characters on typeset invoices, to avoid losing things off the right margin.  Defaults to 50.  ',
5475     'type'        => 'text',
5476   },
5477
5478   {
5479     'key'         => 'invoice_payment_details',
5480     'section'     => 'invoicing',
5481     '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.',
5482     'type'        => 'checkbox',
5483   },
5484
5485   {
5486     'key'         => 'cust_main-status_module',
5487     'section'     => 'UI',
5488     'description' => 'Which module to use for customer status display.  The "Classic" module (the default) considers accounts with cancelled recurring packages but un-cancelled one-time charges Inactive.  The "Recurring" module considers those customers Cancelled.  Similarly for customers with suspended recurring packages but one-time charges.  Restart Apache after changing.', #other differences?
5489     'type'        => 'select',
5490     'select_enum' => [ 'Classic', 'Recurring' ],
5491   },
5492
5493   {
5494     'key'         => 'username-pound',
5495     'section'     => 'username',
5496     'description' => 'Allow the pound character (#) in usernames.',
5497     'type'        => 'checkbox',
5498   },
5499
5500   {
5501     'key'         => 'username-exclamation',
5502     'section'     => 'username',
5503     'description' => 'Allow the exclamation character (!) in usernames.',
5504     'type'        => 'checkbox',
5505   },
5506
5507   {
5508     'key'         => 'ie-compatibility_mode',
5509     'section'     => 'UI',
5510     '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.",
5511     'type'        => 'select',
5512     'select_enum' => [ '', '7', 'EmulateIE7', '8', 'EmulateIE8' ],
5513   },
5514
5515   {
5516     'key'         => 'disable_payauto_default',
5517     'section'     => 'UI',
5518     'description' => 'Disable the "Charge future payments to this (card|check) automatically" checkbox from defaulting to checked.',
5519     'type'        => 'checkbox',
5520   },
5521
5522   {
5523     'key'         => 'payment-history-report',
5524     'section'     => 'UI',
5525     'description' => 'Show a link to the raw database payment history report in the Reports menu.  DO NOT ENABLE THIS for modern installations.',
5526     'type'        => 'checkbox',
5527   },
5528
5529   {
5530     'key'         => 'svc_broadband-require-nw-coordinates',
5531     'section'     => 'deprecated',
5532     'description' => 'Deprecated; see geocode-require_nw_coordinates instead',
5533     'type'        => 'checkbox',
5534   },
5535
5536   {
5537     'key'         => 'cust-edit-alt-field-order',
5538     'section'     => 'UI',
5539     'description' => 'An alternate ordering of fields for the New Customer and Edit Customer screens.',
5540     'type'        => 'checkbox',
5541   },
5542
5543   {
5544     'key'         => 'cust_bill-enable_promised_date',
5545     'section'     => 'UI',
5546     'description' => 'Enable display/editing of the "promised payment date" field on invoices.',
5547     'type'        => 'checkbox',
5548   },
5549
5550   {
5551     'key'         => 'available-locales',
5552     'section'     => '',
5553     'description' => 'Limit available locales (employee preferences, per-customer locale selection, etc.) to a particular set.',
5554     'type'        => 'select-sub',
5555     'multiple'    => 1,
5556     'options_sub' => sub {
5557       map { $_ => FS::Locales->description($_) }
5558       FS::Locales->locales;
5559     },
5560     'option_sub'  => sub { FS::Locales->description(shift) },
5561   },
5562
5563   {
5564     'key'         => 'cust_main-require_locale',
5565     'section'     => 'UI',
5566     'description' => 'Require an explicit locale to be chosen for new customers.',
5567     'type'        => 'checkbox',
5568   },
5569
5570   {
5571     'key'         => 'translate-auto-insert',
5572     'section'     => '',
5573     '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.',
5574     'type'        => 'select',
5575     'multiple'    => 1,
5576     'select_enum' => [ grep { $_ ne 'en_US' } FS::Locales::locales ],
5577   },
5578
5579   {
5580     'key'         => 'svc_acct-tower_sector',
5581     'section'     => '',
5582     'description' => 'Track tower and sector for svc_acct (account) services.',
5583     'type'        => 'checkbox',
5584   },
5585
5586   {
5587     'key'         => 'cdr-prerate',
5588     'section'     => 'telephony',
5589     '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.',
5590     'type'        => 'checkbox',
5591   },
5592
5593   {
5594     'key'         => 'cdr-prerate-cdrtypenums',
5595     'section'     => 'telephony',
5596     'description' => 'When using cdr-prerate to rate CDRs immediately, limit processing to these CDR types.',
5597     'type'        => 'select-sub',
5598     'multiple'    => 1,
5599     'options_sub' => sub { require FS::Record;
5600                            require FS::cdr_type;
5601                            map { $_->cdrtypenum => $_->cdrtypename }
5602                                FS::Record::qsearch( 'cdr_type',
5603                                                     {} #{ 'disabled' => '' }
5604                                                   );
5605                          },
5606     'option_sub'  => sub { require FS::Record;
5607                            require FS::cdr_type;
5608                            my $cdr_type = FS::Record::qsearchs(
5609                              'cdr_type', { 'cdrtypenum'=>shift } );
5610                            $cdr_type ? $cdr_type->cdrtypename : '';
5611                          },
5612   },
5613
5614   {
5615     'key'         => 'cdr-minutes_priority',
5616     'section'     => 'telephony',
5617     'description' => 'Priority rule for assigning included minutes to CDRs.',
5618     'type'        => 'select',
5619     'select_hash' => [
5620       ''          => 'No specific order',
5621       'time'      => 'Chronological',
5622       'rate_high' => 'Highest rate first',
5623       'rate_low'  => 'Lowest rate first',
5624     ],
5625   },
5626
5627   {
5628     'key'         => 'brand-agent',
5629     'section'     => 'UI',
5630     '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.',
5631     'type'        => 'select-agent',
5632   },
5633
5634   {
5635     'key'         => 'cust_class-tax_exempt',
5636     'section'     => 'taxation',
5637     'description' => 'Control the tax exemption flag per customer class rather than per indivual customer.',
5638     'type'        => 'checkbox',
5639   },
5640
5641   {
5642     'key'         => 'selfservice-billing_history-line_items',
5643     'section'     => 'self-service',
5644     'description' => 'Return line item billing detail for the self-service billing_history API call.',
5645     'type'        => 'checkbox',
5646   },
5647
5648   {
5649     'key'         => 'selfservice-default_cdr_format',
5650     'section'     => 'self-service',
5651     'description' => 'Format for showing outbound CDRs in self-service.  The per-package option overrides this.',
5652     'type'        => 'select',
5653     'select_hash' => \@cdr_formats,
5654   },
5655
5656   {
5657     'key'         => 'selfservice-default_inbound_cdr_format',
5658     'section'     => 'self-service',
5659     'description' => 'Format for showing inbound CDRs in self-service.  The per-package option overrides this.  Leave blank to avoid showing these CDRs.',
5660     'type'        => 'select',
5661     'select_hash' => \@cdr_formats,
5662   },
5663
5664   {
5665     'key'         => 'selfservice-hide_cdr_price',
5666     'section'     => 'self-service',
5667     'description' => 'Don\'t show the "Price" column on CDRs in self-service.',
5668     'type'        => 'checkbox',
5669   },
5670
5671   {
5672     'key'         => 'selfservice-enable_payment_without_balance',
5673     'section'     => 'self-service',
5674     'description' => 'Allow selfservice customers to make payments even if balance is zero or below (resulting in an unapplied payment and negative balance.)',
5675     'type'        => 'checkbox',
5676   },
5677
5678   {
5679     'key'         => 'selfservice-announcement',
5680     'section'     => 'self-service',
5681     'description' => 'HTML announcement to display to all authenticated users on account overview page',
5682     'type'        => 'textarea',
5683   },
5684
5685   {
5686     'key'         => 'logout-timeout',
5687     'section'     => 'UI',
5688     'description' => 'If set, automatically log users out of the backoffice after this many minutes.',
5689     'type'       => 'text',
5690   },
5691
5692   {
5693     'key'         => 'spreadsheet_format',
5694     'section'     => 'UI',
5695     'description' => 'Default format for spreadsheet download.',
5696     'type'        => 'select',
5697     'select_hash' => [
5698       'XLS' => 'XLS (Excel 97/2000/XP)',
5699       'XLSX' => 'XLSX (Excel 2007+)',
5700     ],
5701   },
5702
5703   {
5704     'key'         => 'report-cust_pay-select_time',
5705     'section'     => 'UI',
5706     'description' => 'Enable time selection on payment and refund reports.',
5707     'type'        => 'checkbox',
5708   },
5709
5710   {
5711     'key'         => 'authentication_module',
5712     'section'     => 'UI',
5713     'description' => '"Internal" is the default , which authenticates against the internal database.  "Legacy" is similar, but matches passwords against a legacy htpasswd file.',
5714     'type'        => 'select',
5715     'select_enum' => [qw( Internal Legacy )],
5716   },
5717
5718   {
5719     'key'         => 'external_auth-access_group-template_user',
5720     'section'     => 'UI',
5721     'description' => 'When using an external authentication module, specifies the default access groups for autocreated users, via a template user.',
5722     'type'        => 'text',
5723   },
5724
5725   {
5726     'key'         => 'allow_invalid_cards',
5727     'section'     => '',
5728     'description' => 'Accept invalid credit card numbers.  Useful for testing with fictitious customers.  There is no good reason to enable this in production.',
5729     'type'        => 'checkbox',
5730   },
5731
5732   {
5733     'key'         => 'default_credit_limit',
5734     'section'     => 'billing',
5735     'description' => 'Default customer credit limit',
5736     'type'        => 'text',
5737   },
5738
5739   {
5740     'key'         => 'api_shared_secret',
5741     'section'     => 'API',
5742     'description' => 'Shared secret for back-office API authentication',
5743     'type'        => 'text',
5744   },
5745
5746   {
5747     'key'         => 'xmlrpc_api',
5748     'section'     => 'API',
5749     'description' => 'Enable the back-office API XML-RPC server (on port 8008).',
5750     'type'        => 'checkbox',
5751   },
5752
5753 #  {
5754 #    'key'         => 'jsonrpc_api',
5755 #    'section'     => 'API',
5756 #    'description' => 'Enable the back-office API JSON-RPC server (on port 8081).',
5757 #    'type'        => 'checkbox',
5758 #  },
5759
5760   {
5761     'key'         => 'api_credit_reason',
5762     'section'     => 'API',
5763     'description' => 'Default reason for back-office API credits',
5764     'type'        => 'select-sub',
5765     #false laziness w/api_credit_reason
5766     'options_sub' => sub { require FS::Record;
5767                            require FS::reason;
5768                            my $type = qsearchs('reason_type',
5769                              { class => 'R' })
5770                               or return ();
5771                            map { $_->reasonnum => $_->reason }
5772                                FS::Record::qsearch('reason',
5773                                  { reason_type => $type->typenum }
5774                                );
5775                          },
5776     'option_sub'  => sub { require FS::Record;
5777                            require FS::reason;
5778                            my $reason = FS::Record::qsearchs(
5779                              'reason', { 'reasonnum' => shift }
5780                            );
5781                            $reason ? $reason->reason : '';
5782                          },
5783   },
5784
5785   {
5786     'key'         => 'part_pkg-term_discounts',
5787     'section'     => 'billing',
5788     'description' => 'Enable the term discounts feature.  Recommended to keep turned off unless actually using - not well optimized for large installations.',
5789     'type'        => 'checkbox',
5790   },
5791
5792   {
5793     'key'         => 'prepaid-never_renew',
5794     'section'     => 'billing',
5795     'description' => 'Prepaid packages never renew.',
5796     'type'        => 'checkbox',
5797   },
5798
5799   {
5800     'key'         => 'agent-disable_counts',
5801     'section'     => 'UI',
5802     '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.',
5803     'type'        => 'checkbox',
5804   },
5805
5806   {
5807     'key'         => 'tollfree-country',
5808     'section'     => 'telephony',
5809     'description' => 'Country / region for toll-free recognition',
5810     'type'        => 'select',
5811     'select_hash' => [ ''   => 'NANPA (US/Canada)',
5812                        'AU' => 'Australia',
5813                        'NZ' => 'New Zealand',
5814                      ],
5815   },
5816
5817   {
5818     'key'         => 'old_fcc_report',
5819     'section'     => '',
5820     'description' => 'Use the old (pre-2014) FCC Form 477 report format.',
5821     'type'        => 'checkbox',
5822   },
5823
5824   {
5825     'key'         => 'cust_main-default_commercial',
5826     'section'     => 'UI',
5827     'description' => 'Default for new customers is commercial rather than residential.',
5828     'type'        => 'checkbox',
5829   },
5830
5831   {
5832     'key'         => 'default_appointment_length',
5833     'section'     => 'UI',
5834     'description' => 'Default appointment length, in minutes (30 minute granularity).',
5835     'type'        => 'text',
5836   },
5837
5838   # for internal use only; test databases should declare this option and
5839   # everyone else should pretend it doesn't exist
5840   #{
5841   #  'key'         => 'no_random_ids',
5842   #  'section'     => '',
5843   #  'description' => 'Replace random identifiers in UI code with a static string, for repeatable testing. Don\'t use in production.',
5844   #  'type'        => 'checkbox',
5845   #},
5846
5847 );
5848
5849 1;
5850