FS/FS/Conf.pm

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