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