FS/FS/Conf.pm

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