FS/FS/Conf.pm

   1 package FS::Conf;
   2
   3 use vars qw($base_dir @config_items @base_items @card_types $DEBUG);
   4 use Carp;
   5 use IO::File;
   6 use File::Basename;
   7 use MIME::Base64;
   8 use FS::ConfItem;
   9 use FS::ConfDefaults;
  10 use FS::Conf_compat17;
  11 use FS::payby;
  12 use FS::conf;
  13 use FS::Record qw(qsearch qsearchs);
  14 use FS::UID qw(dbh datasrc use_confcompat);
  15
  16 $base_dir = '%%%FREESIDE_CONF%%%';
  17
  18 $DEBUG = 0;
  19
  20 =head1 NAME
  21
  22 FS::Conf - Freeside configuration values
  23
  24 =head1 SYNOPSIS
  25
  26   use FS::Conf;
  27
  28   $conf = new FS::Conf;
  29
  30   $value = $conf->config('key');
  31   @list  = $conf->config('key');
  32   $bool  = $conf->exists('key');
  33
  34   $conf->touch('key');
  35   $conf->set('key' => 'value');
  36   $conf->delete('key');
  37
  38   @config_items = $conf->config_items;
  39
  40 =head1 DESCRIPTION
  41
  42 Read and write Freeside configuration values.  Keys currently map to filenames,
  43 but this may change in the future.
  44
  45 =head1 METHODS
  46
  47 =over 4
  48
  49 =item new
  50
  51 Create a new configuration object.
  52
  53 =cut
  54
  55 sub new {
  56   my($proto) = @_;
  57   my($class) = ref($proto) || $proto;
  58   my($self) = { 'base_dir' => $base_dir };
  59   bless ($self, $class);
  60 }
  61
  62 =item base_dir
  63
  64 Returns the base directory.  By default this is /usr/local/etc/freeside.
  65
  66 =cut
  67
  68 sub base_dir {
  69   my($self) = @_;
  70   my $base_dir = $self->{base_dir};
  71   -e $base_dir or die "FATAL: $base_dir doesn't exist!";
  72   -d $base_dir or die "FATAL: $base_dir isn't a directory!";
  73   -r $base_dir or die "FATAL: Can't read $base_dir!";
  74   -x $base_dir or die "FATAL: $base_dir not searchable (executable)!";
  75   $base_dir =~ /^(.*)$/;
  76   $1;
  77 }
  78
  79 =item conf KEY [ AGENTNUM [ NODEFAULT ] ]
  80
  81 Returns the L<FS::conf> record for the key and agent.
  82
  83 =cut
  84
  85 sub conf {
  86   my $self = shift;
  87   $self->_config(@_);
  88 }
  89
  90 =item config KEY [ AGENTNUM [ NODEFAULT ] ]
  91
  92 Returns the configuration value or values (depending on context) for key.
  93 The optional agent number selects an agent specific value instead of the
  94 global default if one is present.  If NODEFAULT is true only the agent
  95 specific value(s) is returned.
  96
  97 =cut
  98
  99 sub _usecompat {
 100   my ($self, $method) = (shift, shift);
 101   carp "NO CONFIGURATION RECORDS FOUND -- USING COMPATIBILITY MODE"
 102     if use_confcompat;
 103   my $compat = new FS::Conf_compat17 ("$base_dir/conf." . datasrc);
 104   $compat->$method(@_);
 105 }
 106
 107 sub _config {
 108   my($self,$name,$agentnum,$agentonly)=@_;
 109   my $hashref = { 'name' => $name };
 110   $hashref->{agentnum} = $agentnum;
 111   local $FS::Record::conf = undef;  # XXX evil hack prevents recursion
 112   my $cv = FS::Record::qsearchs('conf', $hashref);
 113   if (!$agentonly && !$cv && defined($agentnum) && $agentnum) {
 114     $hashref->{agentnum} = '';
 115     $cv = FS::Record::qsearchs('conf', $hashref);
 116   }
 117   return $cv;
 118 }
 119
 120 sub config {
 121   my $self = shift;
 122   return $self->_usecompat('config', @_) if use_confcompat;
 123
 124   carp "FS::Conf->config(". join(', ', @_). ") called"
 125     if $DEBUG > 1;
 126
 127   my $cv = $self->_config(@_) or return;
 128
 129   if ( wantarray ) {
 130     my $v = $cv->value;
 131     chomp $v;
 132     (split "\n", $v, -1);
 133   } else {
 134     (split("\n", $cv->value))[0];
 135   }
 136 }
 137
 138 =item config_binary KEY [ AGENTNUM [ NODEFAULT ] ]
 139
 140 Returns the exact scalar value for key.
 141
 142 =cut
 143
 144 sub config_binary {
 145   my $self = shift;
 146   return $self->_usecompat('config_binary', @_) if use_confcompat;
 147
 148   my $cv = $self->_config(@_) or return;
 149   length($cv->value) ? decode_base64($cv->value) : '';
 150 }
 151
 152 =item exists KEY [ AGENTNUM [ NODEFAULT ] ]
 153
 154 Returns true if the specified key exists, even if the corresponding value
 155 is undefined.
 156
 157 =cut
 158
 159 sub exists {
 160   my $self = shift;
 161   return $self->_usecompat('exists', @_) if use_confcompat;
 162
 163   my($name, $agentnum)=@_;
 164
 165   carp "FS::Conf->exists(". join(', ', @_). ") called"
 166     if $DEBUG > 1;
 167
 168   defined($self->_config(@_));
 169 }
 170
 171 =item config_orbase KEY SUFFIX
 172
 173 Returns the configuration value or values (depending on context) for
 174 KEY_SUFFIX, if it exists, otherwise for KEY
 175
 176 =cut
 177
 178 # outmoded as soon as we shift to agentnum based config values
 179 # well, mostly.  still useful for e.g. late notices, etc. in that we want
 180 # these to fall back to standard values
 181 sub config_orbase {
 182   my $self = shift;
 183   return $self->_usecompat('config_orbase', @_) if use_confcompat;
 184
 185   my( $name, $suffix ) = @_;
 186   if ( $self->exists("${name}_$suffix") ) {
 187     $self->config("${name}_$suffix");
 188   } else {
 189     $self->config($name);
 190   }
 191 }
 192
 193 =item key_orbase KEY SUFFIX
 194
 195 If the config value KEY_SUFFIX exists, returns KEY_SUFFIX, otherwise returns
 196 KEY.  Useful for determining which exact configuration option is returned by
 197 config_orbase.
 198
 199 =cut
 200
 201 sub key_orbase {
 202   my $self = shift;
 203   #no compat for this...return $self->_usecompat('config_orbase', @_) if use_confcompat;
 204
 205   my( $name, $suffix ) = @_;
 206   if ( $self->exists("${name}_$suffix") ) {
 207     "${name}_$suffix";
 208   } else {
 209     $name;
 210   }
 211 }
 212
 213 =item invoice_templatenames
 214
 215 Returns all possible invoice template names.
 216
 217 =cut
 218
 219 sub invoice_templatenames {
 220   my( $self ) = @_;
 221
 222   my %templatenames = ();
 223   foreach my $item ( $self->config_items ) {
 224     foreach my $base ( @base_items ) {
 225       my( $main, $ext) = split(/\./, $base);
 226       $ext = ".$ext" if $ext;
 227       if ( $item->key =~ /^${main}_(.+)$ext$/ ) {
 228       $templatenames{$1}++;
 229       }
 230     }
 231   }
 232
 233   map { $_ } #handle scalar context
 234   sort keys %templatenames;
 235
 236 }
 237
 238 =item touch KEY [ AGENT ];
 239
 240 Creates the specified configuration key if it does not exist.
 241
 242 =cut
 243
 244 sub touch {
 245   my $self = shift;
 246   return $self->_usecompat('touch', @_) if use_confcompat;
 247
 248   my($name, $agentnum) = @_;
 249   unless ( $self->exists($name, $agentnum) ) {
 250     $self->set($name, '', $agentnum);
 251   }
 252 }
 253
 254 =item set KEY VALUE [ AGENTNUM ];
 255
 256 Sets the specified configuration key to the given value.
 257
 258 =cut
 259
 260 sub set {
 261   my $self = shift;
 262   return $self->_usecompat('set', @_) if use_confcompat;
 263
 264   my($name, $value, $agentnum) = @_;
 265   $value =~ /^(.*)$/s;
 266   $value = $1;
 267
 268   warn "[FS::Conf] SET $name\n" if $DEBUG;
 269
 270   my $old = FS::Record::qsearchs('conf', {name => $name, agentnum => $agentnum});
 271   my $new = new FS::conf { $old ? $old->hash
 272                                 : ('name' => $name, 'agentnum' => $agentnum)
 273                          };
 274   $new->value($value);
 275
 276   my $error;
 277   if ($old) {
 278     $error = $new->replace($old);
 279   } else {
 280     $error = $new->insert;
 281   }
 282
 283   die "error setting configuration value: $error \n"
 284     if $error;
 285
 286 }
 287
 288 =item set_binary KEY VALUE [ AGENTNUM ]
 289
 290 Sets the specified configuration key to an exact scalar value which
 291 can be retrieved with config_binary.
 292
 293 =cut
 294
 295 sub set_binary {
 296   my $self  = shift;
 297   return if use_confcompat;
 298
 299   my($name, $value, $agentnum)=@_;
 300   $self->set($name, encode_base64($value), $agentnum);
 301 }
 302
 303 =item delete KEY [ AGENTNUM ];
 304
 305 Deletes the specified configuration key.
 306
 307 =cut
 308
 309 sub delete {
 310   my $self = shift;
 311   return $self->_usecompat('delete', @_) if use_confcompat;
 312
 313   my($name, $agentnum) = @_;
 314   if ( my $cv = FS::Record::qsearchs('conf', {name => $name, agentnum => $agentnum}) ) {
 315     warn "[FS::Conf] DELETE $name\n";
 316
 317     my $oldAutoCommit = $FS::UID::AutoCommit;
 318     local $FS::UID::AutoCommit = 0;
 319     my $dbh = dbh;
 320
 321     my $error = $cv->delete;
 322
 323     if ( $error ) {
 324       $dbh->rollback if $oldAutoCommit;
 325       die "error setting configuration value: $error \n"
 326     }
 327
 328     $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 329
 330   }
 331 }
 332
 333 =item import_config_item CONFITEM DIR
 334
 335   Imports the item specified by the CONFITEM (see L<FS::ConfItem>) into
 336 the database as a conf record (see L<FS::conf>).  Imports from the file
 337 in the directory DIR.
 338
 339 =cut
 340
 341 sub import_config_item {
 342   my ($self,$item,$dir) = @_;
 343   my $key = $item->key;
 344   if ( -e "$dir/$key" && ! use_confcompat ) {
 345     warn "Inserting $key\n" if $DEBUG;
 346     local $/;
 347     my $value = readline(new IO::File "$dir/$key");
 348     if ($item->type =~ /^(binary|image)$/ ) {
 349       $self->set_binary($key, $value);
 350     }else{
 351       $self->set($key, $value);
 352     }
 353   }else {
 354     warn "Not inserting $key\n" if $DEBUG;
 355   }
 356 }
 357
 358 =item verify_config_item CONFITEM DIR
 359
 360   Compares the item specified by the CONFITEM (see L<FS::ConfItem>) in
 361 the database to the legacy file value in DIR.
 362
 363 =cut
 364
 365 sub verify_config_item {
 366   return '' if use_confcompat;
 367   my ($self,$item,$dir) = @_;
 368   my $key = $item->key;
 369   my $type = $item->type;
 370
 371   my $compat = new FS::Conf_compat17 $dir;
 372   my $error = '';
 373
 374   $error .= "$key fails existential comparison; "
 375     if $self->exists($key) xor $compat->exists($key);
 376
 377   if ( $type !~ /^(binary|image)$/ ) {
 378
 379     {
 380       no warnings;
 381       $error .= "$key fails scalar comparison; "
 382         unless scalar($self->config($key)) eq scalar($compat->config($key));
 383     }
 384
 385     my (@new) = $self->config($key);
 386     my (@old) = $compat->config($key);
 387     unless ( scalar(@new) == scalar(@old)) {
 388       $error .= "$key fails list comparison; ";
 389     }else{
 390       my $r=1;
 391       foreach (@old) { $r=0 if ($_ cmp shift(@new)); }
 392       $error .= "$key fails list comparison; "
 393         unless $r;
 394     }
 395
 396   } else {
 397
 398     no warnings 'uninitialized';
 399     $error .= "$key fails binary comparison; "
 400       unless scalar($self->config_binary($key)) eq scalar($compat->config_binary($key));
 401
 402   }
 403
 404 #remove deprecated config on our own terms, not freeside-upgrade's
 405 #  if ($error =~ /existential comparison/ && $item->section eq 'deprecated') {
 406 #    my $proto;
 407 #    for ( @config_items ) { $proto = $_; last if $proto->key eq $key;  }
 408 #    unless ($proto->key eq $key) {
 409 #      warn "removed config item $error\n" if $DEBUG;
 410 #      $error = '';
 411 #    }
 412 #  }
 413
 414   $error;
 415 }
 416
 417 #item _orbase_items OPTIONS
 418 #
 419 #Returns all of the possible extensible config items as FS::ConfItem objects.
 420 #See #L<FS::ConfItem>.  OPTIONS consists of name value pairs.  Possible
 421 #options include
 422 #
 423 # dir - the directory to search for configuration option files instead
 424 #       of using the conf records in the database
 425 #
 426 #cut
 427
 428 #quelle kludge
 429 sub _orbase_items {
 430   my ($self, %opt) = @_;
 431
 432   my $listmaker = sub { my $v = shift;
 433                         $v =~ s/_/!_/g;
 434                         if ( $v =~ /\.(png|eps)$/ ) {
 435                           $v =~ s/\./!_%./;
 436                         }else{
 437                           $v .= '!_%';
 438                         }
 439                         map { $_->name }
 440                           FS::Record::qsearch( 'conf',
 441                                                {},
 442                                                '',
 443                                                "WHERE name LIKE '$v' ESCAPE '!'"
 444                                              );
 445                       };
 446
 447   if (exists($opt{dir}) && $opt{dir}) {
 448     $listmaker = sub { my $v = shift;
 449                        if ( $v =~ /\.(png|eps)$/ ) {
 450                          $v =~ s/\./_*./;
 451                        }else{
 452                          $v .= '_*';
 453                        }
 454                        map { basename $_ } glob($opt{dir}. "/$v" );
 455                      };
 456   }
 457
 458   ( map {
 459           my $proto;
 460           my $base = $_;
 461           for ( @config_items ) { $proto = $_; last if $proto->key eq $base;  }
 462           die "don't know about $base items" unless $proto->key eq $base;
 463
 464           map { new FS::ConfItem {
 465                   'key'         => $_,
 466                   'base_key'    => $proto->key,
 467                   'section'     => $proto->section,
 468                   'description' => 'Alternate ' . $proto->description . '  See the <a href="http://www.freeside.biz/mediawiki/index.php/Freeside:1.7:Documentation:Administration#Invoice_templates">billing documentation</a> for details.',
 469                   'type'        => $proto->type,
 470                 };
 471               } &$listmaker($base);
 472         } @base_items,
 473   );
 474 }
 475
 476 =item config_items
 477
 478 Returns all of the possible global/default configuration items as
 479 FS::ConfItem objects.  See L<FS::ConfItem>.
 480
 481 =cut
 482
 483 sub config_items {
 484   my $self = shift;
 485   return $self->_usecompat('config_items', @_) if use_confcompat;
 486
 487   ( @config_items, $self->_orbase_items(@_) );
 488 }
 489
 490 =back
 491
 492 =head1 SUBROUTINES
 493
 494 =over 4
 495
 496 =item init-config DIR
 497
 498 Imports the configuration items from DIR (1.7 compatible)
 499 to conf records in the database.
 500
 501 =cut
 502
 503 sub init_config {
 504   my $dir = shift;
 505
 506   {
 507     local $FS::UID::use_confcompat = 0;
 508     my $conf = new FS::Conf;
 509     foreach my $item ( $conf->config_items(dir => $dir) ) {
 510       $conf->import_config_item($item, $dir);
 511       my $error = $conf->verify_config_item($item, $dir);
 512       return $error if $error;
 513     }
 514
 515     my $compat = new FS::Conf_compat17 $dir;
 516     foreach my $item ( $compat->config_items ) {
 517       my $error = $conf->verify_config_item($item, $dir);
 518       return $error if $error;
 519     }
 520   }
 521
 522   $FS::UID::use_confcompat = 0;
 523   '';  #success
 524 }
 525
 526 =back
 527
 528 =head1 BUGS
 529
 530 If this was more than just crud that will never be useful outside Freeside I'd
 531 worry that config_items is freeside-specific and icky.
 532
 533 =head1 SEE ALSO
 534
 535 "Configuration" in the web interface (config/config.cgi).
 536
 537 =cut
 538
 539 #Business::CreditCard
 540 @card_types = (
 541   "VISA card",
 542   "MasterCard",
 543   "Discover card",
 544   "American Express card",
 545   "Diner's Club/Carte Blanche",
 546   "enRoute",
 547   "JCB",
 548   "BankCard",
 549   "Switch",
 550   "Solo",
 551 );
 552
 553 @base_items = qw(
 554 invoice_template
 555 invoice_latex
 556 invoice_latexreturnaddress
 557 invoice_latexfooter
 558 invoice_latexsmallfooter
 559 invoice_latexnotes
 560 invoice_latexcoupon
 561 invoice_html
 562 invoice_htmlreturnaddress
 563 invoice_htmlfooter
 564 invoice_htmlnotes
 565 logo.png
 566 logo.eps
 567 );
 568
 569 my %msg_template_options = (
 570   'type'        => 'select-sub',
 571   'options_sub' => sub {
 572     my @templates = qsearch({
 573         'table' => 'msg_template',
 574         'hashref' => { 'disabled' => '' },
 575         'extra_sql' => ' AND '.
 576           $FS::CurrentUser::CurrentUser->agentnums_sql(null => 1),
 577         });
 578     map { $_->msgnum, $_->msgname } @templates;
 579   },
 580   'option_sub'  => sub {
 581                          my $msg_template = FS::msg_template->by_key(shift);
 582                          $msg_template ? $msg_template->msgname : ''
 583                        },
 584   'per_agent' => 1,
 585 );
 586
 587 my $_gateway_name = sub {
 588   my $g = shift;
 589   return '' if !$g;
 590   ($g->gateway_username . '@' . $g->gateway_module);
 591 };
 592
 593 my %payment_gateway_options = (
 594   'type'        => 'select-sub',
 595   'options_sub' => sub {
 596     my @gateways = qsearch({
 597         'table' => 'payment_gateway',
 598         'hashref' => { 'disabled' => '' },
 599       });
 600     map { $_->gatewaynum, $_gateway_name->($_) } @gateways;
 601   },
 602   'option_sub'  => sub {
 603     my $gateway = FS::payment_gateway->by_key(shift);
 604     $_gateway_name->($gateway);
 605   },
 606 );
 607
 608 #Billing (81 items)
 609 #Invoicing (50 items)
 610 #UI (69 items)
 611 #Self-service (29 items)
 612 #...
 613 #Unclassified (77 items)
 614
 615 @config_items = map { new FS::ConfItem $_ } (
 616
 617   {
 618     'key'         => 'address',
 619     'section'     => 'deprecated',
 620     'description' => 'This configuration option is no longer used.  See <a href="#invoice_template">invoice_template</a> instead.',
 621     'type'        => 'text',
 622   },
 623
 624   {
 625     'key'         => 'alert_expiration',
 626     'section'     => 'notification',
 627     'description' => 'Enable alerts about billing method expiration (i.e. expiring credit cards).',
 628     'type'        => 'checkbox',
 629     'per_agent'   => 1,
 630   },
 631
 632   {
 633     'key'         => 'alerter_template',
 634     'section'     => 'deprecated',
 635     'description' => 'Template file for billing method expiration alerts (i.e. expiring credit cards).',
 636     'type'        => 'textarea',
 637     'per_agent'   => 1,
 638   },
 639
 640   {
 641     'key'         => 'alerter_msgnum',
 642     'section'     => 'notification',
 643     'description' => 'Template to use for credit card expiration alerts.',
 644     %msg_template_options,
 645   },
 646
 647   {
 648     'key'         => 'apacheip',
 649     #not actually deprecated yet
 650     #'section'     => 'deprecated',
 651     #'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',
 652     'section'     => '',
 653     'description' => 'IP address to assign to new virtual hosts',
 654     'type'        => 'text',
 655   },
 656
 657   {
 658     'key'         => 'discount-show-always',
 659     'section'     => 'billing',
 660     'description' => 'Generate a line item on an invoice even when a package is discounted 100%',
 661     'type'        => 'checkbox',
 662   },
 663
 664   {
 665     'key'         => 'invoice-barcode',
 666     'section'     => 'billing',
 667     'description' => 'Display a barcode on HTML and PDF invoices',
 668     'type'        => 'checkbox',
 669   },
 670
 671   {
 672     'key'         => 'encryption',
 673     'section'     => 'billing',
 674     'description' => 'Enable encryption of credit cards.',
 675     'type'        => 'checkbox',
 676   },
 677
 678   {
 679     'key'         => 'encryptionmodule',
 680     'section'     => 'billing',
 681     'description' => 'Use which module for encryption?',
 682     'type'        => 'text',
 683   },
 684
 685   {
 686     'key'         => 'encryptionpublickey',
 687     'section'     => 'billing',
 688     'description' => 'Your RSA Public Key - Required if Encryption is turned on.',
 689     'type'        => 'textarea',
 690   },
 691
 692   {
 693     'key'         => 'encryptionprivatekey',
 694     'section'     => 'billing',
 695     'description' => 'Your RSA Private Key - Including this will enable the "Bill Now" feature.  However if the system is compromised, a hacker can use this key to decode the stored credit card information.  This is generally not a good idea.',
 696     'type'        => 'textarea',
 697   },
 698
 699   {
 700     'key'         => 'billco-url',
 701     'section'     => 'billing',
 702     'description' => 'The url to use for performing uploads to the invoice mailing service.',
 703     'type'        => 'text',
 704     'per_agent'   => 1,
 705   },
 706
 707   {
 708     'key'         => 'billco-username',
 709     'section'     => 'billing',
 710     'description' => 'The login name to use for uploads to the invoice mailing service.',
 711     'type'        => 'text',
 712     'per_agent'   => 1,
 713     'agentonly'   => 1,
 714   },
 715
 716   {
 717     'key'         => 'billco-password',
 718     'section'     => 'billing',
 719     'description' => 'The password to use for uploads to the invoice mailing service.',
 720     'type'        => 'text',
 721     'per_agent'   => 1,
 722     'agentonly'   => 1,
 723   },
 724
 725   {
 726     'key'         => 'billco-clicode',
 727     'section'     => 'billing',
 728     'description' => 'The clicode to use for uploads to the invoice mailing service.',
 729     'type'        => 'text',
 730     'per_agent'   => 1,
 731   },
 732
 733   {
 734     'key'         => 'business-onlinepayment',
 735     'section'     => 'billing',
 736     '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.',
 737     'type'        => 'textarea',
 738   },
 739
 740   {
 741     'key'         => 'business-onlinepayment-ach',
 742     'section'     => 'billing',
 743     '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.',
 744     'type'        => 'textarea',
 745   },
 746
 747   {
 748     'key'         => 'business-onlinepayment-namespace',
 749     'section'     => 'billing',
 750     'description' => 'Specifies which perl module namespace (which group of collection routines) is used by default.',
 751     'type'        => 'select',
 752     'select_hash' => [
 753                        'Business::OnlinePayment' => 'Direct API (Business::OnlinePayment)',
 754                        'Business::OnlineThirdPartyPayment' => 'Web API (Business::ThirdPartyPayment)',
 755                      ],
 756   },
 757
 758   {
 759     'key'         => 'business-onlinepayment-description',
 760     'section'     => 'billing',
 761     '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)',
 762     'type'        => 'text',
 763   },
 764
 765   {
 766     'key'         => 'business-onlinepayment-email-override',
 767     'section'     => 'billing',
 768     'description' => 'Email address used instead of customer email address when submitting a BOP transaction.',
 769     'type'        => 'text',
 770   },
 771
 772   {
 773     'key'         => 'business-onlinepayment-email_customer',
 774     'section'     => 'billing',
 775     'description' => 'Controls the "email_customer" flag used by some Business::OnlinePayment processors to enable customer receipts.',
 776     'type'        => 'checkbox',
 777   },
 778
 779   {
 780     'key'         => 'business-onlinepayment-test_transaction',
 781     'section'     => 'billing',
 782     '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.',
 783     'type'        => 'checkbox',
 784   },
 785
 786   {
 787     'key'         => 'countrydefault',
 788     'section'     => 'UI',
 789     'description' => 'Default two-letter country code (if not supplied, the default is `US\')',
 790     'type'        => 'text',
 791   },
 792
 793   {
 794     'key'         => 'date_format',
 795     'section'     => 'UI',
 796     'description' => 'Format for displaying dates',
 797     'type'        => 'select',
 798     'select_hash' => [
 799                        '%m/%d/%Y' => 'MM/DD/YYYY',
 800                        '%d/%m/%Y' => 'DD/MM/YYYY',
 801                        '%Y/%m/%d' => 'YYYY/MM/DD',
 802                      ],
 803   },
 804
 805   {
 806     'key'         => 'date_format_long',
 807     'section'     => 'UI',
 808     'description' => 'Verbose format for displaying dates',
 809     'type'        => 'select',
 810     'select_hash' => [
 811                        '%b %o, %Y' => 'Mon DDth, YYYY',
 812                        '%e %b %Y'  => 'DD Mon YYYY',
 813                      ],
 814   },
 815
 816   {
 817     'key'         => 'deletecustomers',
 818     'section'     => 'UI',
 819     'description' => 'Enable customer deletions.  Be very careful!  Deleting a customer will remove all traces that the customer ever existed!  It should probably only be used when auditing a legacy database.  Normally, you cancel all of a customers\' packages if they cancel service.',
 820     'type'        => 'checkbox',
 821   },
 822
 823   {
 824     'key'         => 'deleteinvoices',
 825     'section'     => 'UI',
 826     'description' => 'Enable invoices deletions.  Be very careful!  Deleting an invoice will remove all traces that the invoice ever existed!  Normally, you would apply a credit against the invoice instead.',  #invoice voiding?
 827     'type'        => 'checkbox',
 828   },
 829
 830   {
 831     'key'         => 'deletepayments',
 832     'section'     => 'billing',
 833     'description' => 'Enable deletion of unclosed payments.  Really, with voids this is pretty much not recommended in any situation anymore.  Be very careful!  Only delete payments that were data-entry errors, not adjustments.  Optionally specify one or more comma-separated email addresses to be notified when a payment is deleted.',
 834     'type'        => [qw( checkbox text )],
 835   },
 836
 837   {
 838     'key'         => 'deletecredits',
 839     #not actually deprecated yet
 840     #'section'     => 'deprecated',
 841     #'description' => '<B>DEPRECATED</B>, now controlled by ACLs.  Used to enable deletion of unclosed credits.  Be very careful!  Only delete credits that were data-entry errors, not adjustments.  Optionally specify one or more comma-separated email addresses to be notified when a credit is deleted.',
 842     'section'     => '',
 843     'description' => 'One or more comma-separated email addresses to be notified when a credit is deleted.',
 844     'type'        => [qw( checkbox text )],
 845   },
 846
 847   {
 848     'key'         => 'deleterefunds',
 849     'section'     => 'billing',
 850     'description' => 'Enable deletion of unclosed refunds.  Be very careful!  Only delete refunds that were data-entry errors, not adjustments.',
 851     'type'        => 'checkbox',
 852   },
 853
 854   {
 855     'key'         => 'unapplypayments',
 856     'section'     => 'deprecated',
 857     'description' => '<B>DEPRECATED</B>, now controlled by ACLs.  Used to enable "unapplication" of unclosed payments.',
 858     'type'        => 'checkbox',
 859   },
 860
 861   {
 862     'key'         => 'unapplycredits',
 863     'section'     => 'deprecated',
 864     'description' => '<B>DEPRECATED</B>, now controlled by ACLs.  Used to nable "unapplication" of unclosed credits.',
 865     'type'        => 'checkbox',
 866   },
 867
 868   {
 869     'key'         => 'dirhash',
 870     'section'     => 'shell',
 871     '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>',
 872     'type'        => 'text',
 873   },
 874
 875   {
 876     'key'         => 'disable_cust_attachment',
 877     'section'     => '',
 878     'description' => 'Disable customer file attachments',
 879     'type'        => 'checkbox',
 880   },
 881
 882   {
 883     'key'         => 'max_attachment_size',
 884     'section'     => '',
 885     'description' => 'Maximum size for customer file attachments (leave blank for unlimited)',
 886     'type'        => 'text',
 887   },
 888
 889   {
 890     'key'         => 'disable_customer_referrals',
 891     'section'     => 'UI',
 892     'description' => 'Disable new customer-to-customer referrals in the web interface',
 893     'type'        => 'checkbox',
 894   },
 895
 896   {
 897     'key'         => 'editreferrals',
 898     'section'     => 'UI',
 899     'description' => 'Enable advertising source modification for existing customers',
 900     'type'        => 'checkbox',
 901   },
 902
 903   {
 904     'key'         => 'emailinvoiceonly',
 905     'section'     => 'invoicing',
 906     'description' => 'Disables postal mail invoices',
 907     'type'        => 'checkbox',
 908   },
 909
 910   {
 911     'key'         => 'disablepostalinvoicedefault',
 912     'section'     => 'invoicing',
 913     '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>.',
 914     'type'        => 'checkbox',
 915   },
 916
 917   {
 918     'key'         => 'emailinvoiceauto',
 919     'section'     => 'invoicing',
 920     'description' => 'Automatically adds new accounts to the email invoice list',
 921     'type'        => 'checkbox',
 922   },
 923
 924   {
 925     'key'         => 'emailinvoiceautoalways',
 926     'section'     => 'invoicing',
 927     'description' => 'Automatically adds new accounts to the email invoice list even when the list contains email addresses',
 928     'type'        => 'checkbox',
 929   },
 930
 931   {
 932     'key'         => 'emailinvoice-apostrophe',
 933     'section'     => 'invoicing',
 934     'description' => 'Allows the apostrophe (single quote) character in the email addresses in the email invoice list.',
 935     'type'        => 'checkbox',
 936   },
 937
 938   {
 939     'key'         => 'exclude_ip_addr',
 940     'section'     => '',
 941     'description' => 'Exclude these from the list of available broadband service IP addresses. (One per line)',
 942     'type'        => 'textarea',
 943   },
 944
 945   {
 946     'key'         => 'auto_router',
 947     'section'     => '',
 948     'description' => 'Automatically choose the correct router/block based on supplied ip address when possible while provisioning broadband services',
 949     'type'        => 'checkbox',
 950   },
 951
 952   {
 953     'key'         => 'hidecancelledpackages',
 954     'section'     => 'UI',
 955     'description' => 'Prevent cancelled packages from showing up in listings (though they will still be in the database)',
 956     'type'        => 'checkbox',
 957   },
 958
 959   {
 960     'key'         => 'hidecancelledcustomers',
 961     'section'     => 'UI',
 962     'description' => 'Prevent customers with only cancelled packages from showing up in listings (though they will still be in the database)',
 963     'type'        => 'checkbox',
 964   },
 965
 966   {
 967     'key'         => 'home',
 968     'section'     => 'shell',
 969     'description' => 'For new users, prefixed to username to create a directory name.  Should have a leading but not a trailing slash.',
 970     'type'        => 'text',
 971   },
 972
 973   {
 974     'key'         => 'invoice_from',
 975     'section'     => 'required',
 976     'description' => 'Return address on email invoices',
 977     'type'        => 'text',
 978     'per_agent'   => 1,
 979   },
 980
 981   {
 982     'key'         => 'invoice_subject',
 983     'section'     => 'invoicing',
 984     'description' => 'Subject: header on email invoices.  Defaults to "Invoice".  The following substitutions are available: $name, $name_short, $invoice_number, and $invoice_date.',
 985     'type'        => 'text',
 986     'per_agent'   => 1,
 987   },
 988
 989   {
 990     'key'         => 'invoice_usesummary',
 991     'section'     => 'invoicing',
 992     'description' => 'Indicates that html and latex invoices should be in summary style and make use of invoice_latexsummary.',
 993     'type'        => 'checkbox',
 994   },
 995
 996   {
 997     'key'         => 'invoice_template',
 998     'section'     => 'invoicing',
 999     '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:1.7:Documentation:Administration#Plaintext_invoice_templates">billing documentation</a> for details.',
1000     'type'        => 'textarea',
1001   },
1002
1003   {
1004     'key'         => 'invoice_html',
1005     'section'     => 'invoicing',
1006     'description' => 'Optional HTML template for invoices.  See the <a href="http://www.freeside.biz/mediawiki/index.php/Freeside:1.7:Documentation:Administration#HTML_invoice_templates">billing documentation</a> for details.',
1007
1008     'type'        => 'textarea',
1009   },
1010
1011   {
1012     'key'         => 'invoice_htmlnotes',
1013     'section'     => 'invoicing',
1014     'description' => 'Notes section for HTML invoices.  Defaults to the same data in invoice_latexnotes if not specified.',
1015     'type'        => 'textarea',
1016     'per_agent'   => 1,
1017   },
1018
1019   {
1020     'key'         => 'invoice_htmlfooter',
1021     'section'     => 'invoicing',
1022     'description' => 'Footer for HTML invoices.  Defaults to the same data in invoice_latexfooter if not specified.',
1023     'type'        => 'textarea',
1024     'per_agent'   => 1,
1025   },
1026
1027   {
1028     'key'         => 'invoice_htmlsummary',
1029     'section'     => 'invoicing',
1030     'description' => 'Summary initial page for HTML invoices.',
1031     'type'        => 'textarea',
1032     'per_agent'   => 1,
1033   },
1034
1035   {
1036     'key'         => 'invoice_htmlreturnaddress',
1037     'section'     => 'invoicing',
1038     'description' => 'Return address for HTML invoices.  Defaults to the same data in invoice_latexreturnaddress if not specified.',
1039     'type'        => 'textarea',
1040   },
1041
1042   {
1043     'key'         => 'invoice_latex',
1044     'section'     => 'invoicing',
1045     'description' => 'Optional LaTeX template for typeset PostScript invoices.  See the <a href="http://www.freeside.biz/mediawiki/index.php/Freeside:1.7:Documentation:Administration#Typeset_.28LaTeX.29_invoice_templates">billing documentation</a> for details.',
1046     'type'        => 'textarea',
1047   },
1048
1049   {
1050     'key'         => 'invoice_latextopmargin',
1051     'section'     => 'invoicing',
1052     'description' => 'Optional LaTeX invoice topmargin setting. Include units.',
1053     'type'        => 'text',
1054     'per_agent'   => 1,
1055     'validate'    => sub { shift =~
1056                              /^-?\d*\.?\d+(in|mm|cm|pt|em|ex|pc|bp|dd|cc|sp)$/
1057                              ? '' : 'Invalid LaTex length';
1058                          },
1059   },
1060
1061   {
1062     'key'         => 'invoice_latexheadsep',
1063     'section'     => 'invoicing',
1064     'description' => 'Optional LaTeX invoice headsep setting. Include units.',
1065     'type'        => 'text',
1066     'per_agent'   => 1,
1067     'validate'    => sub { shift =~
1068                              /^-?\d*\.?\d+(in|mm|cm|pt|em|ex|pc|bp|dd|cc|sp)$/
1069                              ? '' : 'Invalid LaTex length';
1070                          },
1071   },
1072
1073   {
1074     'key'         => 'invoice_latexaddresssep',
1075     'section'     => 'invoicing',
1076     'description' => 'Optional LaTeX invoice separation between invoice header
1077 and customer address. Include units.',
1078     'type'        => 'text',
1079     'per_agent'   => 1,
1080     'validate'    => sub { shift =~
1081                              /^-?\d*\.?\d+(in|mm|cm|pt|em|ex|pc|bp|dd|cc|sp)$/
1082                              ? '' : 'Invalid LaTex length';
1083                          },
1084   },
1085
1086   {
1087     'key'         => 'invoice_latextextheight',
1088     'section'     => 'invoicing',
1089     'description' => 'Optional LaTeX invoice textheight setting. Include units.',
1090     'type'        => 'text',
1091     'per_agent'   => 1,
1092     'validate'    => sub { shift =~
1093                              /^-?\d*\.?\d+(in|mm|cm|pt|em|ex|pc|bp|dd|cc|sp)$/
1094                              ? '' : 'Invalid LaTex length';
1095                          },
1096   },
1097
1098   {
1099     'key'         => 'invoice_latexnotes',
1100     'section'     => 'invoicing',
1101     'description' => 'Notes section for LaTeX typeset PostScript invoices.',
1102     'type'        => 'textarea',
1103     'per_agent'   => 1,
1104   },
1105
1106   {
1107     'key'         => 'invoice_latexfooter',
1108     'section'     => 'invoicing',
1109     'description' => 'Footer for LaTeX typeset PostScript invoices.',
1110     'type'        => 'textarea',
1111     'per_agent'   => 1,
1112   },
1113
1114   {
1115     'key'         => 'invoice_latexsummary',
1116     'section'     => 'invoicing',
1117     'description' => 'Summary initial page for LaTeX typeset PostScript invoices.',
1118     'type'        => 'textarea',
1119     'per_agent'   => 1,
1120   },
1121
1122   {
1123     'key'         => 'invoice_latexcoupon',
1124     'section'     => 'invoicing',
1125     'description' => 'Remittance coupon for LaTeX typeset PostScript invoices.',
1126     'type'        => 'textarea',
1127     'per_agent'   => 1,
1128   },
1129
1130   {
1131     'key'         => 'invoice_latexextracouponspace',
1132     'section'     => 'invoicing',
1133     'description' => 'Optional LaTeX invoice textheight space to reserve for a tear off coupon. Include units.',
1134     'type'        => 'text',
1135     'per_agent'   => 1,
1136     'validate'    => sub { shift =~
1137                              /^-?\d*\.?\d+(in|mm|cm|pt|em|ex|pc|bp|dd|cc|sp)$/
1138                              ? '' : 'Invalid LaTex length';
1139                          },
1140   },
1141
1142   {
1143     'key'         => 'invoice_latexcouponfootsep',
1144     'section'     => 'invoicing',
1145     'description' => 'Optional LaTeX invoice separation between tear off coupon and footer. Include units.',
1146     'type'        => 'text',
1147     'per_agent'   => 1,
1148     'validate'    => sub { shift =~
1149                              /^-?\d*\.?\d+(in|mm|cm|pt|em|ex|pc|bp|dd|cc|sp)$/
1150                              ? '' : 'Invalid LaTex length';
1151                          },
1152   },
1153
1154   {
1155     'key'         => 'invoice_latexcouponamountenclosedsep',
1156     'section'     => 'invoicing',
1157     'description' => 'Optional LaTeX invoice separation between total due and amount enclosed line. Include units.',
1158     'type'        => 'text',
1159     'per_agent'   => 1,
1160     'validate'    => sub { shift =~
1161                              /^-?\d*\.?\d+(in|mm|cm|pt|em|ex|pc|bp|dd|cc|sp)$/
1162                              ? '' : 'Invalid LaTex length';
1163                          },
1164   },
1165   {
1166     'key'         => 'invoice_latexcoupontoaddresssep',
1167     'section'     => 'invoicing',
1168     'description' => 'Optional LaTeX invoice separation between invoice data and the to address (usually invoice_latexreturnaddress).  Include units.',
1169     'type'        => 'text',
1170     'per_agent'   => 1,
1171     'validate'    => sub { shift =~
1172                              /^-?\d*\.?\d+(in|mm|cm|pt|em|ex|pc|bp|dd|cc|sp)$/
1173                              ? '' : 'Invalid LaTex length';
1174                          },
1175   },
1176
1177   {
1178     'key'         => 'invoice_latexreturnaddress',
1179     'section'     => 'invoicing',
1180     'description' => 'Return address for LaTeX typeset PostScript invoices.',
1181     'type'        => 'textarea',
1182   },
1183
1184   {
1185     'key'         => 'invoice_latexverticalreturnaddress',
1186     'section'     => 'invoicing',
1187     'description' => 'Place the return address under the company logo rather than beside it.',
1188     'type'        => 'checkbox',
1189     'per_agent'   => 1,
1190   },
1191
1192   {
1193     'key'         => 'invoice_latexcouponaddcompanytoaddress',
1194     'section'     => 'invoicing',
1195     'description' => 'Add the company name to the To address on the remittance coupon because the return address does not contain it.',
1196     'type'        => 'checkbox',
1197     'per_agent'   => 1,
1198   },
1199
1200   {
1201     'key'         => 'invoice_latexsmallfooter',
1202     'section'     => 'invoicing',
1203     'description' => 'Optional small footer for multi-page LaTeX typeset PostScript invoices.',
1204     'type'        => 'textarea',
1205     'per_agent'   => 1,
1206   },
1207
1208   {
1209     'key'         => 'invoice_email_pdf',
1210     'section'     => 'invoicing',
1211     'description' => 'Send PDF invoice as an attachment to emailed invoices.  By default, includes the plain text invoice as the email body, unless invoice_email_pdf_note is set.',
1212     'type'        => 'checkbox'
1213   },
1214
1215   {
1216     'key'         => 'invoice_email_pdf_note',
1217     'section'     => 'invoicing',
1218     'description' => 'If defined, this text will replace the default plain text invoice as the body of emailed PDF invoices.',
1219     'type'        => 'textarea'
1220   },
1221
1222   {
1223     'key'         => 'invoice_print_pdf',
1224     'section'     => 'invoicing',
1225     'description' => 'Store postal invoices for download in PDF format rather than printing them directly.',
1226     'type'        => 'checkbox',
1227   },
1228
1229   {
1230     'key'         => 'invoice_default_terms',
1231     'section'     => 'invoicing',
1232     'description' => 'Optional default invoice term, used to calculate a due date printed on invoices.',
1233     'type'        => 'select',
1234     'select_enum' => [ '', 'Payable upon receipt', 'Net 0', 'Net 3', 'Net 10', 'Net 15', 'Net 20', 'Net 21', 'Net 30', 'Net 45', 'Net 60', 'Net 90' ],
1235   },
1236
1237   {
1238     'key'         => 'invoice_show_prior_due_date',
1239     'section'     => 'invoicing',
1240     'description' => 'Show previous invoice due dates when showing prior balances.  Default is to show invoice date.',
1241     'type'        => 'checkbox',
1242   },
1243
1244   {
1245     'key'         => 'invoice_include_aging',
1246     'section'     => 'invoicing',
1247     'description' => 'Show an aging line after the prior balance section.  Only valud when invoice_sections is enabled.',
1248     'type'        => 'checkbox',
1249   },
1250
1251   {
1252     'key'         => 'invoice_sections',
1253     'section'     => 'invoicing',
1254     'description' => 'Split invoice into sections and label according to package category when enabled.',
1255     'type'        => 'checkbox',
1256   },
1257
1258   {
1259     'key'         => 'usage_class_as_a_section',
1260     'section'     => 'invoicing',
1261     'description' => 'Split usage into sections and label according to usage class name when enabled.  Only valid when invoice_sections is enabled.',
1262     'type'        => 'checkbox',
1263   },
1264
1265   {
1266     'key'         => 'phone_usage_class_summary',
1267     'section'     => 'invoicing',
1268     'description' => 'Summarize usage per DID by usage class and display all CDRs together regardless of usage class. Only valid when svc_phone_sections is enabled.',
1269     'type'        => 'checkbox',
1270   },
1271
1272   {
1273     'key'         => 'svc_phone_sections',
1274     'section'     => 'invoicing',
1275     'description' => 'Create a section for each svc_phone when enabled.  Only valid when invoice_sections is enabled.',
1276     'type'        => 'checkbox',
1277   },
1278
1279   {
1280     'key'         => 'finance_pkgclass',
1281     'section'     => 'billing',
1282     'description' => 'The default package class for late fee charges, used if the fee event does not specify a package class itself.',
1283     'type'        => 'select-pkg_class',
1284   },
1285
1286   {
1287     'key'         => 'separate_usage',
1288     'section'     => 'invoicing',
1289     'description' => 'Split the rated call usage into a separate line from the recurring charges.',
1290     'type'        => 'checkbox',
1291   },
1292
1293   {
1294     'key'         => 'invoice_send_receipts',
1295     'section'     => 'deprecated',
1296     'description' => '<b>DEPRECATED</b>, this used to send an invoice copy on payments and credits.  See the payment_receipt_email and XXXX instead.',
1297     'type'        => 'checkbox',
1298   },
1299
1300   {
1301     'key'         => 'payment_receipt',
1302     'section'     => 'notification',
1303     'description' => 'Send payment receipts.',
1304     'type'        => 'checkbox',
1305     'per_agent'   => 1,
1306   },
1307
1308   {
1309     'key'         => 'payment_receipt_msgnum',
1310     'section'     => 'notification',
1311     'description' => 'Template to use for payment receipts.',
1312     %msg_template_options,
1313   },
1314
1315   {
1316     'key'         => 'payment_receipt_email',
1317     'section'     => 'deprecated',
1318     'description' => 'Template file for payment receipts.  Payment receipts are sent to the customer email invoice destination(s) when a payment is received.',
1319     'type'        => [qw( checkbox textarea )],
1320   },
1321
1322   {
1323     'key'         => 'payment_receipt-trigger',
1324     'section'     => 'notification',
1325     'description' => 'When payment receipts are triggered.  Defaults to when payment is made.',
1326     'type'        => 'select',
1327     'select_hash' => [
1328                        'cust_pay'          => 'When payment is made.',
1329                        'cust_bill_pay_pkg' => 'When payment is applied.',
1330                      ],
1331     'per_agent'   => 1,
1332   },
1333
1334   {
1335     'key'         => 'trigger_export_insert_on_payment',
1336     'section'     => 'billing',
1337     'description' => 'Enable exports on payment application.',
1338     'type'        => 'checkbox',
1339   },
1340
1341   {
1342     'key'         => 'lpr',
1343     'section'     => 'required',
1344     'description' => 'Print command for paper invoices, for example `lpr -h\'',
1345     'type'        => 'text',
1346   },
1347
1348   {
1349     'key'         => 'lpr-postscript_prefix',
1350     'section'     => 'billing',
1351     'description' => 'Raw printer commands prepended to the beginning of postscript print jobs (evaluated as a double-quoted perl string - backslash escapes are available)',
1352     'type'        => 'text',
1353   },
1354
1355   {
1356     'key'         => 'lpr-postscript_suffix',
1357     'section'     => 'billing',
1358     'description' => 'Raw printer commands added to the end of postscript print jobs (evaluated as a double-quoted perl string - backslash escapes are available)',
1359     'type'        => 'text',
1360   },
1361
1362   {
1363     'key'         => 'money_char',
1364     'section'     => '',
1365     'description' => 'Currency symbol - defaults to `$\'',
1366     'type'        => 'text',
1367   },
1368
1369   {
1370     'key'         => 'defaultrecords',
1371     'section'     => 'BIND',
1372     'description' => 'DNS entries to add automatically when creating a domain',
1373     'type'        => 'editlist',
1374     'editlist_parts' => [ { type=>'text' },
1375                           { type=>'immutable', value=>'IN' },
1376                           { type=>'select',
1377                             select_enum => {
1378                               map { $_=>$_ }
1379                                   #@{ FS::domain_record->rectypes }
1380                                   qw(A AAAA CNAME MX NS PTR SPF SRV TXT)
1381                             },
1382                           },
1383                           { type=> 'text' }, ],
1384   },
1385
1386   {
1387     'key'         => 'passwordmin',
1388     'section'     => 'password',
1389     'description' => 'Minimum password length (default 6)',
1390     'type'        => 'text',
1391   },
1392
1393   {
1394     'key'         => 'passwordmax',
1395     'section'     => 'password',
1396     'description' => 'Maximum password length (default 8) (don\'t set this over 12 if you need to import or export crypt() passwords)',
1397     'type'        => 'text',
1398   },
1399
1400   {
1401     'key'         => 'password-noampersand',
1402     'section'     => 'password',
1403     'description' => 'Disallow ampersands in passwords',
1404     'type'        => 'checkbox',
1405   },
1406
1407   {
1408     'key'         => 'password-noexclamation',
1409     'section'     => 'password',
1410     'description' => 'Disallow exclamations in passwords (Not setting this could break old text Livingston or Cistron Radius servers)',
1411     'type'        => 'checkbox',
1412   },
1413
1414   {
1415     'key'         => 'default-password-encoding',
1416     'section'     => 'password',
1417     'description' => 'Default storage format for passwords',
1418     'type'        => 'select',
1419     'select_hash' => [
1420       'plain'       => 'Plain text',
1421       'crypt-des'   => 'Unix password (DES encrypted)',
1422       'crypt-md5'   => 'Unix password (MD5 digest)',
1423       'ldap-plain'  => 'LDAP (plain text)',
1424       'ldap-crypt'  => 'LDAP (DES encrypted)',
1425       'ldap-md5'    => 'LDAP (MD5 digest)',
1426       'ldap-sha1'   => 'LDAP (SHA1 digest)',
1427       'legacy'      => 'Legacy mode',
1428     ],
1429   },
1430
1431   {
1432     'key'         => 'referraldefault',
1433     'section'     => 'UI',
1434     'description' => 'Default referral, specified by refnum',
1435     'type'        => 'select-sub',
1436     'options_sub' => sub { require FS::Record;
1437                            require FS::part_referral;
1438                            map { $_->refnum => $_->referral }
1439                                FS::Record::qsearch( 'part_referral',
1440                                                     { 'disabled' => '' }
1441                                                   );
1442                          },
1443     'option_sub'  => sub { require FS::Record;
1444                            require FS::part_referral;
1445                            my $part_referral = FS::Record::qsearchs(
1446                              'part_referral', { 'refnum'=>shift } );
1447                            $part_referral ? $part_referral->referral : '';
1448                          },
1449   },
1450
1451 #  {
1452 #    'key'         => 'registries',
1453 #    'section'     => 'required',
1454 #    'description' => 'Directory which contains domain registry information.  Each registry is a directory.',
1455 #  },
1456
1457   {
1458     'key'         => 'report_template',
1459     'section'     => 'deprecated',
1460     'description' => 'Deprecated template file for reports.',
1461     'type'        => 'textarea',
1462   },
1463
1464   {
1465     'key'         => 'maxsearchrecordsperpage',
1466     'section'     => 'UI',
1467     'description' => 'If set, number of search records to return per page.',
1468     'type'        => 'text',
1469   },
1470
1471   {
1472     'key'         => 'session-start',
1473     'section'     => 'session',
1474     'description' => 'If defined, the command which is executed on the Freeside machine when a session begins.  The contents of the file are treated as a double-quoted perl string, with the following variables available: <code>$ip</code>, <code>$nasip</code> and <code>$nasfqdn</code>, which are the IP address of the starting session, and the IP address and fully-qualified domain name of the NAS this session is on.',
1475     'type'        => 'text',
1476   },
1477
1478   {
1479     'key'         => 'session-stop',
1480     'section'     => 'session',
1481     'description' => 'If defined, the command which is executed on the Freeside machine when a session ends.  The contents of the file are treated as a double-quoted perl string, with the following variables available: <code>$ip</code>, <code>$nasip</code> and <code>$nasfqdn</code>, which are the IP address of the starting session, and the IP address and fully-qualified domain name of the NAS this session is on.',
1482     'type'        => 'text',
1483   },
1484
1485   {
1486     'key'         => 'shells',
1487     'section'     => 'shell',
1488     '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.',
1489     'type'        => 'textarea',
1490   },
1491
1492   {
1493     'key'         => 'showpasswords',
1494     'section'     => 'UI',
1495     'description' => 'Display unencrypted user passwords in the backend (employee) web interface',
1496     'type'        => 'checkbox',
1497   },
1498
1499   {
1500     'key'         => 'report-showpasswords',
1501     'section'     => 'UI',
1502     'description' => 'This is a terrible idea.  Do not enable it.  STRONGLY NOT RECOMMENDED.  Enables display of passwords on services reports.',
1503     'type'        => 'checkbox',
1504   },
1505
1506   {
1507     'key'         => 'signupurl',
1508     'section'     => 'UI',
1509     '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:1.7:Documentation:Self-Service_Installation">signup server CGI</a>, the customer view screen will display a customized link to the signup server with the appropriate customer as referral',
1510     'type'        => 'text',
1511   },
1512
1513   {
1514     'key'         => 'smtpmachine',
1515     'section'     => 'required',
1516     'description' => 'SMTP relay for Freeside\'s outgoing mail',
1517     'type'        => 'text',
1518   },
1519
1520   {
1521     'key'         => 'smtp-username',
1522     'section'     => '',
1523     'description' => 'Optional SMTP username for Freeside\'s outgoing mail',
1524     'type'        => 'text',
1525   },
1526
1527   {
1528     'key'         => 'smtp-password',
1529     'section'     => '',
1530     'description' => 'Optional SMTP password for Freeside\'s outgoing mail',
1531     'type'        => 'text',
1532   },
1533
1534   {
1535     'key'         => 'smtp-encryption',
1536     'section'     => '',
1537     'description' => 'Optional SMTP encryption method.  The STARTTLS methods require smtp-username and smtp-password to be set.',
1538     'type'        => 'select',
1539     'select_hash' => [ '25'           => 'None (port 25)',
1540                        '25-starttls'  => 'STARTTLS (port 25)',
1541                        '587-starttls' => 'STARTTLS / submission (port 587)',
1542                        '465-tls'      => 'SMTPS (SSL) (port 465)',
1543                      ],
1544   },
1545
1546   {
1547     'key'         => 'soadefaultttl',
1548     'section'     => 'BIND',
1549     'description' => 'SOA default TTL for new domains.',
1550     'type'        => 'text',
1551   },
1552
1553   {
1554     'key'         => 'soaemail',
1555     'section'     => 'BIND',
1556     'description' => 'SOA email for new domains, in BIND form (`.\' instead of `@\'), with trailing `.\'',
1557     'type'        => 'text',
1558   },
1559
1560   {
1561     'key'         => 'soaexpire',
1562     'section'     => 'BIND',
1563     'description' => 'SOA expire for new domains',
1564     'type'        => 'text',
1565   },
1566
1567   {
1568     'key'         => 'soamachine',
1569     'section'     => 'BIND',
1570     'description' => 'SOA machine for new domains, with trailing `.\'',
1571     'type'        => 'text',
1572   },
1573
1574   {
1575     'key'         => 'soarefresh',
1576     'section'     => 'BIND',
1577     'description' => 'SOA refresh for new domains',
1578     'type'        => 'text',
1579   },
1580
1581   {
1582     'key'         => 'soaretry',
1583     'section'     => 'BIND',
1584     'description' => 'SOA retry for new domains',
1585     'type'        => 'text',
1586   },
1587
1588   {
1589     'key'         => 'statedefault',
1590     'section'     => 'UI',
1591     'description' => 'Default state or province (if not supplied, the default is `CA\')',
1592     'type'        => 'text',
1593   },
1594
1595   {
1596     'key'         => 'unsuspendauto',
1597     'section'     => 'billing',
1598     'description' => 'Enables the automatic unsuspension of suspended packages when a customer\'s balance due changes from positive to zero or negative as the result of a payment or credit',
1599     'type'        => 'checkbox',
1600   },
1601
1602   {
1603     'key'         => 'unsuspend-always_adjust_next_bill_date',
1604     'section'     => 'billing',
1605     '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.',
1606     'type'        => 'checkbox',
1607   },
1608
1609   {
1610     'key'         => 'usernamemin',
1611     'section'     => 'username',
1612     'description' => 'Minimum username length (default 2)',
1613     'type'        => 'text',
1614   },
1615
1616   {
1617     'key'         => 'usernamemax',
1618     'section'     => 'username',
1619     'description' => 'Maximum username length',
1620     'type'        => 'text',
1621   },
1622
1623   {
1624     'key'         => 'username-ampersand',
1625     'section'     => 'username',
1626     '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.',
1627     'type'        => 'checkbox',
1628   },
1629
1630   {
1631     'key'         => 'username-letter',
1632     'section'     => 'username',
1633     'description' => 'Usernames must contain at least one letter',
1634     'type'        => 'checkbox',
1635     'per_agent'   => 1,
1636   },
1637
1638   {
1639     'key'         => 'username-letterfirst',
1640     'section'     => 'username',
1641     'description' => 'Usernames must start with a letter',
1642     'type'        => 'checkbox',
1643   },
1644
1645   {
1646     'key'         => 'username-noperiod',
1647     'section'     => 'username',
1648     'description' => 'Disallow periods in usernames',
1649     'type'        => 'checkbox',
1650   },
1651
1652   {
1653     'key'         => 'username-nounderscore',
1654     'section'     => 'username',
1655     'description' => 'Disallow underscores in usernames',
1656     'type'        => 'checkbox',
1657   },
1658
1659   {
1660     'key'         => 'username-nodash',
1661     'section'     => 'username',
1662     'description' => 'Disallow dashes in usernames',
1663     'type'        => 'checkbox',
1664   },
1665
1666   {
1667     'key'         => 'username-uppercase',
1668     'section'     => 'username',
1669     'description' => 'Allow uppercase characters in usernames.  Not recommended for use with FreeRADIUS with MySQL backend, which is case-insensitive by default.',
1670     'type'        => 'checkbox',
1671   },
1672
1673   {
1674     'key'         => 'username-percent',
1675     'section'     => 'username',
1676     'description' => 'Allow the percent character (%) in usernames.',
1677     'type'        => 'checkbox',
1678   },
1679
1680   {
1681     'key'         => 'username-colon',
1682     'section'     => 'username',
1683     'description' => 'Allow the colon character (:) in usernames.',
1684     'type'        => 'checkbox',
1685   },
1686
1687   {
1688     'key'         => 'username-slash',
1689     'section'     => 'username',
1690     '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.',
1691     'type'        => 'checkbox',
1692   },
1693
1694   {
1695     'key'         => 'username-equals',
1696     'section'     => 'username',
1697     'description' => 'Allow the equal sign character (=) in usernames.',
1698     'type'        => 'checkbox',
1699   },
1700
1701   {
1702     'key'         => 'safe-part_bill_event',
1703     'section'     => 'UI',
1704     'description' => 'Validates invoice event expressions against a preset list.  Useful for webdemos, annoying to powerusers.',
1705     'type'        => 'checkbox',
1706   },
1707
1708   {
1709     'key'         => 'show_ss',
1710     'section'     => 'UI',
1711     'description' => 'Turns on display/collection of social security numbers in the web interface.  Sometimes required by electronic check (ACH) processors.',
1712     'type'        => 'checkbox',
1713   },
1714
1715   {
1716     'key'         => 'show_stateid',
1717     'section'     => 'UI',
1718     'description' => "Turns on display/collection of driver's license/state issued id numbers in the web interface.  Sometimes required by electronic check (ACH) processors.",
1719     'type'        => 'checkbox',
1720   },
1721
1722   {
1723     'key'         => 'show_bankstate',
1724     'section'     => 'UI',
1725     'description' => "Turns on display/collection of state for bank accounts in the web interface.  Sometimes required by electronic check (ACH) processors.",
1726     'type'        => 'checkbox',
1727   },
1728
1729   {
1730     'key'         => 'agent_defaultpkg',
1731     'section'     => 'UI',
1732     'description' => 'Setting this option will cause new packages to be available to all agent types by default.',
1733     'type'        => 'checkbox',
1734   },
1735
1736   {
1737     'key'         => 'legacy_link',
1738     'section'     => 'UI',
1739     'description' => 'Display options in the web interface to link legacy pre-Freeside services.',
1740     'type'        => 'checkbox',
1741   },
1742
1743   {
1744     'key'         => 'legacy_link-steal',
1745     'section'     => 'UI',
1746     'description' => 'Allow "stealing" an already-audited service from one customer (or package) to another using the link function.',
1747     'type'        => 'checkbox',
1748   },
1749
1750   {
1751     'key'         => 'queue_dangerous_controls',
1752     'section'     => 'UI',
1753     '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.',
1754     'type'        => 'checkbox',
1755   },
1756
1757   {
1758     'key'         => 'security_phrase',
1759     'section'     => 'password',
1760     'description' => 'Enable the tracking of a "security phrase" with each account.  Not recommended, as it is vulnerable to social engineering.',
1761     'type'        => 'checkbox',
1762   },
1763
1764   {
1765     'key'         => 'locale',
1766     'section'     => 'UI',
1767     'description' => 'Message locale',
1768     'type'        => 'select',
1769     'select_enum' => [ qw(en_US) ],
1770   },
1771
1772   {
1773     'key'         => 'signup_server-payby',
1774     'section'     => 'self-service',
1775     'description' => 'Acceptable payment types for the signup server',
1776     'type'        => 'selectmultiple',
1777     'select_enum' => [ qw(CARD DCRD CHEK DCHK LECB PREPAY BILL COMP) ],
1778   },
1779
1780   {
1781     'key'         => 'selfservice-payment_gateway',
1782     'section'     => 'self-service',
1783     'description' => 'Force the use of this payment gateway for self-service.',
1784     %payment_gateway_options,
1785   },
1786
1787   {
1788     'key'         => 'selfservice-save_unchecked',
1789     'section'     => 'self-service',
1790     'description' => 'In self-service, uncheck "Remember information" checkboxes by default (normally, they are checked by default).',
1791     'type'        => 'checkbox',
1792   },
1793
1794   {
1795     'key'         => 'signup_server-default_agentnum',
1796     'section'     => 'self-service',
1797     'description' => 'Default agent for the signup server',
1798     'type'        => 'select-sub',
1799     'options_sub' => sub { require FS::Record;
1800                            require FS::agent;
1801                            map { $_->agentnum => $_->agent }
1802                                FS::Record::qsearch('agent', { disabled=>'' } );
1803                          },
1804     'option_sub'  => sub { require FS::Record;
1805                            require FS::agent;
1806                            my $agent = FS::Record::qsearchs(
1807                              'agent', { 'agentnum'=>shift }
1808                            );
1809                            $agent ? $agent->agent : '';
1810                          },
1811   },
1812
1813   {
1814     'key'         => 'signup_server-default_refnum',
1815     'section'     => 'self-service',
1816     'description' => 'Default advertising source for the signup server',
1817     'type'        => 'select-sub',
1818     'options_sub' => sub { require FS::Record;
1819                            require FS::part_referral;
1820                            map { $_->refnum => $_->referral }
1821                                FS::Record::qsearch( 'part_referral',
1822                                                     { 'disabled' => '' }
1823                                                   );
1824                          },
1825     'option_sub'  => sub { require FS::Record;
1826                            require FS::part_referral;
1827                            my $part_referral = FS::Record::qsearchs(
1828                              'part_referral', { 'refnum'=>shift } );
1829                            $part_referral ? $part_referral->referral : '';
1830                          },
1831   },
1832
1833   {
1834     'key'         => 'signup_server-default_pkgpart',
1835     'section'     => 'self-service',
1836     'description' => 'Default package for the signup server',
1837     'type'        => 'select-part_pkg',
1838   },
1839
1840   {
1841     'key'         => 'signup_server-default_svcpart',
1842     'section'     => 'self-service',
1843     'description' => 'Default service definition for the signup server - only necessary for services that trigger special provisioning widgets (such as DID provisioning).',
1844     'type'        => 'select-part_svc',
1845   },
1846
1847   {
1848     'key'         => 'signup_server-mac_addr_svcparts',
1849     'section'     => 'self-service',
1850     'description' => 'Service definitions which can receive mac addresses (current mapped to username for svc_acct).',
1851     'type'        => 'select-part_svc',
1852     'multiple'    => 1,
1853   },
1854
1855   {
1856     'key'         => 'signup_server-nomadix',
1857     'section'     => 'self-service',
1858     'description' => 'Signup page Nomadix integration',
1859     'type'        => 'checkbox',
1860   },
1861
1862   {
1863     'key'         => 'signup_server-service',
1864     'section'     => 'self-service',
1865     'description' => 'Service for the signup server - "Account (svc_acct)" is the default setting, or "Phone number (svc_phone)" for ITSP signup',
1866     'type'        => 'select',
1867     'select_hash' => [
1868                        'svc_acct'  => 'Account (svc_acct)',
1869                        'svc_phone' => 'Phone number (svc_phone)',
1870                        'svc_pbx'   => 'PBX (svc_pbx)',
1871                      ],
1872   },
1873
1874   {
1875     'key'         => 'signup_server-prepaid-template-custnum',
1876     'section'     => 'self-service',
1877     'description' => 'When the signup server is used with prepaid cards and customer info is not required for signup, the contact/address info will be copied from this customer, if specified',
1878     'type'        => 'text',
1879   },
1880
1881   {
1882     'key'         => 'selfservice_server-base_url',
1883     'section'     => 'self-service',
1884     '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.',
1885     'type'        => 'text',
1886   },
1887
1888   {
1889     'key'         => 'show-msgcat-codes',
1890     'section'     => 'UI',
1891     'description' => 'Show msgcat codes in error messages.  Turn this option on before reporting errors to the mailing list.',
1892     'type'        => 'checkbox',
1893   },
1894
1895   {
1896     'key'         => 'signup_server-realtime',
1897     'section'     => 'self-service',
1898     'description' => 'Run billing for signup server signups immediately, and do not provision accounts which subsequently have a balance.',
1899     'type'        => 'checkbox',
1900   },
1901
1902   {
1903     'key'         => 'signup_server-classnum2',
1904     'section'     => 'self-service',
1905     'description' => 'Package Class for first optional purchase',
1906     'type'        => 'select-pkg_class',
1907   },
1908
1909   {
1910     'key'         => 'signup_server-classnum3',
1911     'section'     => 'self-service',
1912     'description' => 'Package Class for second optional purchase',
1913     'type'        => 'select-pkg_class',
1914   },
1915
1916   {
1917     'key'         => 'selfservice-xmlrpc',
1918     'section'     => 'self-service',
1919     'description' => 'Run a standalone self-service XML-RPC server on the backend (on port 8080).',
1920     'type'        => 'checkbox',
1921   },
1922
1923   {
1924     'key'         => 'backend-realtime',
1925     'section'     => 'billing',
1926     'description' => 'Run billing for backend signups immediately.',
1927     'type'        => 'checkbox',
1928   },
1929
1930   {
1931     'key'         => 'decline_msgnum',
1932     'section'     => 'notification',
1933     'description' => 'Template to use for credit card and electronic check decline messages.',
1934     %msg_template_options,
1935   },
1936
1937   {
1938     'key'         => 'declinetemplate',
1939     'section'     => 'deprecated',
1940     'description' => 'Template file for credit card and electronic check decline emails.',
1941     'type'        => 'textarea',
1942   },
1943
1944   {
1945     'key'         => 'emaildecline',
1946     'section'     => 'notification',
1947     'description' => 'Enable emailing of credit card and electronic check decline notices.',
1948     'type'        => 'checkbox',
1949     'per_agent'   => 1,
1950   },
1951
1952   {
1953     'key'         => 'emaildecline-exclude',
1954     'section'     => 'notification',
1955     'description' => 'List of error messages that should not trigger email decline notices, one per line.',
1956     'type'        => 'textarea',
1957     'per_agent'   => 1,
1958   },
1959
1960   {
1961     'key'         => 'cancel_msgnum',
1962     'section'     => 'notification',
1963     'description' => 'Template to use for cancellation emails.',
1964     %msg_template_options,
1965   },
1966
1967   {
1968     'key'         => 'cancelmessage',
1969     'section'     => 'deprecated',
1970     'description' => 'Template file for cancellation emails.',
1971     'type'        => 'textarea',
1972   },
1973
1974   {
1975     'key'         => 'cancelsubject',
1976     'section'     => 'deprecated',
1977     'description' => 'Subject line for cancellation emails.',
1978     'type'        => 'text',
1979   },
1980
1981   {
1982     'key'         => 'emailcancel',
1983     'section'     => 'notification',
1984     'description' => 'Enable emailing of cancellation notices.  Make sure to select the template in the cancel_msgnum option.',
1985     'type'        => 'checkbox',
1986     'per_agent'   => 1,
1987   },
1988
1989   {
1990     'key'         => 'bill_usage_on_cancel',
1991     'section'     => 'billing',
1992     '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.',
1993     'type'        => 'checkbox',
1994   },
1995
1996   {
1997     'key'         => 'require_cardname',
1998     'section'     => 'billing',
1999     'description' => 'Require an "Exact name on card" to be entered explicitly; don\'t default to using the first and last name.',
2000     'type'        => 'checkbox',
2001   },
2002
2003   {
2004     'key'         => 'enable_taxclasses',
2005     'section'     => 'billing',
2006     'description' => 'Enable per-package tax classes',
2007     'type'        => 'checkbox',
2008   },
2009
2010   {
2011     'key'         => 'require_taxclasses',
2012     'section'     => 'billing',
2013     'description' => 'Require a taxclass to be entered for every package',
2014     'type'        => 'checkbox',
2015   },
2016
2017   {
2018     'key'         => 'enable_taxproducts',
2019     'section'     => 'billing',
2020     'description' => 'Enable per-package mapping to vendor tax data from CCH or elsewhere.',
2021     'type'        => 'checkbox',
2022   },
2023
2024   {
2025     'key'         => 'taxdatadirectdownload',
2026     'section'     => 'billing',  #well
2027     'description' => 'Enable downloading tax data directly from the vendor site. at least three lines: URL, username, and password.j',
2028     'type'        => 'textarea',
2029   },
2030
2031   {
2032     'key'         => 'ignore_incalculable_taxes',
2033     'section'     => 'billing',
2034     'description' => 'Prefer to invoice without tax over not billing at all',
2035     'type'        => 'checkbox',
2036   },
2037
2038   {
2039     'key'         => 'welcome_msgnum',
2040     'section'     => 'notification',
2041     'description' => 'Template to use for welcome messages when a svc_acct record is created.',
2042     %msg_template_options,
2043   },
2044
2045   {
2046     'key'         => 'welcome_email',
2047     'section'     => 'deprecated',
2048     'description' => 'Template file for welcome email.  Welcome emails are sent to the customer email invoice destination(s) each time a svc_acct record is created.',
2049     'type'        => 'textarea',
2050     'per_agent'   => 1,
2051   },
2052
2053   {
2054     'key'         => 'welcome_email-from',
2055     'section'     => 'deprecated',
2056     'description' => 'From: address header for welcome email',
2057     'type'        => 'text',
2058     'per_agent'   => 1,
2059   },
2060
2061   {
2062     'key'         => 'welcome_email-subject',
2063     'section'     => 'deprecated',
2064     'description' => 'Subject: header for welcome email',
2065     'type'        => 'text',
2066     'per_agent'   => 1,
2067   },
2068
2069   {
2070     'key'         => 'welcome_email-mimetype',
2071     'section'     => 'deprecated',
2072     'description' => 'MIME type for welcome email',
2073     'type'        => 'select',
2074     'select_enum' => [ 'text/plain', 'text/html' ],
2075     'per_agent'   => 1,
2076   },
2077
2078   {
2079     'key'         => 'welcome_letter',
2080     'section'     => '',
2081     '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>',
2082     'type'        => 'textarea',
2083   },
2084
2085 #  {
2086 #    'key'         => 'warning_msgnum',
2087 #    'section'     => 'notification',
2088 #    '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.',
2089 #    %msg_template_options,
2090 #  },
2091
2092   {
2093     'key'         => 'warning_email',
2094     'section'     => 'notification',
2095     'description' => 'Template file for warning email.  Warning emails are sent to the customer email invoice destination(s) each time a svc_acct record has its usage drop below a threshold or 0.  See the <a href="http://search.cpan.org/dist/Text-Template/lib/Text/Template.pm">Text::Template</a> documentation for details on the template substitution language.  The following variables are available<ul><li><code>$username</code> <li><code>$password</code> <li><code>$first</code> <li><code>$last</code> <li><code>$pkg</code> <li><code>$column</code> <li><code>$amount</code> <li><code>$threshold</code></ul>',
2096     'type'        => 'textarea',
2097   },
2098
2099   {
2100     'key'         => 'warning_email-from',
2101     'section'     => 'notification',
2102     'description' => 'From: address header for warning email',
2103     'type'        => 'text',
2104   },
2105
2106   {
2107     'key'         => 'warning_email-cc',
2108     'section'     => 'notification',
2109     'description' => 'Additional recipient(s) (comma separated) for warning email when remaining usage reaches zero.',
2110     'type'        => 'text',
2111   },
2112
2113   {
2114     'key'         => 'warning_email-subject',
2115     'section'     => 'notification',
2116     'description' => 'Subject: header for warning email',
2117     'type'        => 'text',
2118   },
2119
2120   {
2121     'key'         => 'warning_email-mimetype',
2122     'section'     => 'notification',
2123     'description' => 'MIME type for warning email',
2124     'type'        => 'select',
2125     'select_enum' => [ 'text/plain', 'text/html' ],
2126   },
2127
2128   {
2129     'key'         => 'payby',
2130     'section'     => 'billing',
2131     'description' => 'Available payment types.',
2132     'type'        => 'selectmultiple',
2133     'select_enum' => [ qw(CARD DCRD CHEK DCHK LECB BILL CASH WEST MCRD COMP) ],
2134   },
2135
2136   {
2137     'key'         => 'payby-default',
2138     'section'     => 'UI',
2139     'description' => 'Default payment type.  HIDE disables display of billing information and sets customers to BILL.',
2140     'type'        => 'select',
2141     'select_enum' => [ '', qw(CARD DCRD CHEK DCHK LECB BILL CASH WEST MCRD COMP HIDE) ],
2142   },
2143
2144   {
2145     'key'         => 'paymentforcedtobatch',
2146     'section'     => 'deprecated',
2147     'description' => 'See batch-enable_payby and realtime-disable_payby.  Used to (for CHEK): Cause per customer payment entry to be forced to a batch processor rather than performed realtime.',
2148     'type'        => 'checkbox',
2149   },
2150
2151   {
2152     'key'         => 'svc_acct-notes',
2153     'section'     => 'deprecated',
2154     'description' => 'Extra HTML to be displayed on the Account View screen.',
2155     'type'        => 'textarea',
2156   },
2157
2158   {
2159     'key'         => 'radius-password',
2160     'section'     => '',
2161     'description' => 'RADIUS attribute for plain-text passwords.',
2162     'type'        => 'select',
2163     'select_enum' => [ 'Password', 'User-Password', 'Cleartext-Password' ],
2164   },
2165
2166   {
2167     'key'         => 'radius-ip',
2168     'section'     => '',
2169     'description' => 'RADIUS attribute for IP addresses.',
2170     'type'        => 'select',
2171     'select_enum' => [ 'Framed-IP-Address', 'Framed-Address' ],
2172   },
2173
2174   #http://dev.coova.org/svn/coova-chilli/doc/dictionary.chillispot
2175   {
2176     'key'         => 'radius-chillispot-max',
2177     'section'     => '',
2178     'description' => 'Enable ChilliSpot (and CoovaChilli) Max attributes, specifically ChilliSpot-Max-{Input,Output,Total}-{Octets,Gigawords}.',
2179     'type'        => 'checkbox',
2180   },
2181
2182   {
2183     'key'         => 'svc_acct-alldomains',
2184     'section'     => '',
2185     '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.',
2186     'type'        => 'checkbox',
2187   },
2188
2189   {
2190     'key'         => 'dump-scpdest',
2191     'section'     => '',
2192     'description' => 'destination for scp database dumps: user@host:/path',
2193     'type'        => 'text',
2194   },
2195
2196   {
2197     'key'         => 'dump-pgpid',
2198     'section'     => '',
2199     '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.",
2200     'type'        => 'text',
2201   },
2202
2203   {
2204     'key'         => 'users-allow_comp',
2205     'section'     => 'deprecated',
2206     'description' => '<b>DEPRECATED</b>, enable the <i>Complimentary customer</i> access right instead.  Was: Usernames (Freeside users, created with <a href="../docs/man/bin/freeside-adduser.html">freeside-adduser</a>) which can create complimentary customers, one per line.  If no usernames are entered, all users can create complimentary accounts.',
2207     'type'        => 'textarea',
2208   },
2209
2210   {
2211     'key'         => 'credit_card-recurring_billing_flag',
2212     'section'     => 'billing',
2213     '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. ',
2214     'type'        => 'select',
2215     'select_hash' => [
2216                        'actual_oncard' => 'Default/classic behavior: set the flag if a customer has actual previous charges on the card.',
2217                        'transaction_is_recur' => 'Set the flag if the transaction itself is recurring, irregardless of previous charges on the card.',
2218                      ],
2219   },
2220
2221   {
2222     'key'         => 'credit_card-recurring_billing_acct_code',
2223     'section'     => 'billing',
2224     'description' => 'When the "recurring billing" flag is set, also set the "acct_code" to "rebill".  Useful for reporting purposes with supported gateways (PlugNPay, others?)',
2225     'type'        => 'checkbox',
2226   },
2227
2228   {
2229     'key'         => 'cvv-save',
2230     'section'     => 'billing',
2231     'description' => 'Save CVV2 information after the initial transaction for the selected credit card types.  Enabling this option may be in violation of your merchant agreement(s), so please check them carefully before enabling this option for any credit card types.',
2232     'type'        => 'selectmultiple',
2233     'select_enum' => \@card_types,
2234   },
2235
2236   {
2237     'key'         => 'manual_process-pkgpart',
2238     'section'     => 'billing',
2239     'description' => 'Package to add to each manual credit card and ACH payments entered from the backend.  Enabling this option may be in violation of your merchant agreement(s), so please check them carefully before enabling this option.',
2240     'type'        => 'select-part_pkg',
2241   },
2242
2243   {
2244     'key'         => 'manual_process-display',
2245     'section'     => 'billing',
2246     'description' => 'When using manual_process-pkgpart, add the fee to the amount entered (default), or subtract the fee from the amount entered.',
2247     'type'        => 'select',
2248     'select_hash' => [
2249                        'add'      => 'Add fee to amount entered',
2250                        'subtract' => 'Subtract fee from amount entered',
2251                      ],
2252   },
2253
2254   {
2255     'key'         => 'manual_process-skip_first',
2256     'section'     => 'billing',
2257     'description' => "When using manual_process-pkgpart, omit the fee if it is the customer's first payment.",
2258     'type'        => 'checkbox',
2259   },
2260
2261   {
2262     'key'         => 'allow_negative_charges',
2263     'section'     => 'billing',
2264     'description' => 'Allow negative charges.  Normally not used unless importing data from a legacy system that requires this.',
2265     'type'        => 'checkbox',
2266   },
2267   {
2268       'key'         => 'auto_unset_catchall',
2269       'section'     => '',
2270       '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.',
2271       'type'        => 'checkbox',
2272   },
2273
2274   {
2275     'key'         => 'system_usernames',
2276     'section'     => 'username',
2277     '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.',
2278     'type'        => 'textarea',
2279   },
2280
2281   {
2282     'key'         => 'cust_pkg-change_svcpart',
2283     'section'     => '',
2284     'description' => "When changing packages, move services even if svcparts don't match between old and new pacakge definitions.",
2285     'type'        => 'checkbox',
2286   },
2287
2288   {
2289     'key'         => 'cust_pkg-change_pkgpart-bill_now',
2290     'section'     => '',
2291     '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.",
2292     'type'        => 'checkbox',
2293   },
2294
2295   {
2296     'key'         => 'disable_autoreverse',
2297     'section'     => 'BIND',
2298     'description' => 'Disable automatic synchronization of reverse-ARPA entries.',
2299     'type'        => 'checkbox',
2300   },
2301
2302   {
2303     'key'         => 'svc_www-enable_subdomains',
2304     'section'     => '',
2305     'description' => 'Enable selection of specific subdomains for virtual host creation.',
2306     'type'        => 'checkbox',
2307   },
2308
2309   {
2310     'key'         => 'svc_www-usersvc_svcpart',
2311     'section'     => '',
2312     'description' => 'Allowable service definition svcparts for virtual hosts, one per line.',
2313     'type'        => 'select-part_svc',
2314     'multiple'    => 1,
2315   },
2316
2317   {
2318     'key'         => 'selfservice_server-primary_only',
2319     'section'     => 'self-service',
2320     'description' => 'Only allow primary accounts to access self-service functionality.',
2321     'type'        => 'checkbox',
2322   },
2323
2324   {
2325     'key'         => 'selfservice_server-phone_login',
2326     'section'     => 'self-service',
2327     'description' => 'Allow login to self-service with phone number and PIN.',
2328     'type'        => 'checkbox',
2329   },
2330
2331   {
2332     'key'         => 'selfservice_server-single_domain',
2333     'section'     => 'self-service',
2334     'description' => 'If specified, only use this one domain for self-service access.',
2335     'type'        => 'text',
2336   },
2337
2338   {
2339     'key'         => 'selfservice_server-login_svcpart',
2340     'section'     => 'self-service',
2341     'description' => 'If specified, only allow the specified svcparts to login to self-service.',
2342     'type'        => 'select-part_svc',
2343     'multiple'    => 1,
2344   },
2345
2346   {
2347     'key'         => 'selfservice-recent-did-age',
2348     'section'     => 'self-service',
2349     'description' => 'If specified, defines "recent", in number of seconds, for "Download recently allocated DIDs" in self-service.',
2350     'type'        => 'text',
2351   },
2352
2353   {
2354     'key'         => 'selfservice_server-view-wholesale',
2355     'section'     => 'self-service',
2356     'description' => 'If enabled, use a wholesale package view in the self-service.',
2357     'type'        => 'checkbox',
2358   },
2359
2360   {
2361     'key'         => 'selfservice-agent_signup',
2362     'section'     => 'self-service',
2363     'description' => 'Allow agent signup via self-service.',
2364     'type'        => 'checkbox',
2365   },
2366
2367   {
2368     'key'         => 'selfservice-agent_signup-agent_type',
2369     'section'     => 'self-service',
2370     'description' => 'Agent type when allowing agent signup via self-service.',
2371     'type'        => 'select-sub',
2372     'options_sub' => sub { require FS::Record;
2373                            require FS::agent_type;
2374                            map { $_->typenum => $_->atype }
2375                                FS::Record::qsearch('agent_type', {} ); # disabled=>'' } );
2376                          },
2377     'option_sub'  => sub { require FS::Record;
2378                            require FS::agent_type;
2379                            my $agent = FS::Record::qsearchs(
2380                              'agent_type', { 'typenum'=>shift }
2381                            );
2382                            $agent_type ? $agent_type->atype : '';
2383                          },
2384   },
2385
2386   {
2387     'key'         => 'selfservice-agent_login',
2388     'section'     => 'self-service',
2389     'description' => 'Allow agent login via self-service.',
2390     'type'        => 'checkbox',
2391   },
2392
2393   {
2394     'key'         => 'selfservice-self_suspend_reason',
2395     'section'     => 'self-service',
2396     'description' => 'Suspend reason when customers suspend their own packages. Set to nothing to disallow self-suspension.',
2397     'type'        => 'select-sub',
2398     'options_sub' => sub { require FS::Record;
2399                            require FS::reason;
2400                            my $type = qsearchs('reason_type',
2401                              { class => 'S' })
2402                               or return ();
2403                            map { $_->reasonnum => $_->reason }
2404                                FS::Record::qsearch('reason',
2405                                  { reason_type => $type->typenum }
2406                                );
2407                          },
2408     'option_sub'  => sub { require FS::Record;
2409                            require FS::reason;
2410                            my $reason = FS::Record::qsearchs(
2411                              'reason', { 'reasonnum' => shift }
2412                            );
2413                            $reason ? $reason->reason : '';
2414                          },
2415
2416     'per_agent'   => 1,
2417   },
2418
2419   {
2420     'key'         => 'card_refund-days',
2421     'section'     => 'billing',
2422     'description' => 'After a payment, the number of days a refund link will be available for that payment.  Defaults to 120.',
2423     'type'        => 'text',
2424   },
2425
2426   {
2427     'key'         => 'agent-showpasswords',
2428     'section'     => '',
2429     'description' => 'Display unencrypted user passwords in the agent (reseller) interface',
2430     'type'        => 'checkbox',
2431   },
2432
2433   {
2434     'key'         => 'global_unique-username',
2435     'section'     => 'username',
2436     '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.',
2437     'type'        => 'select',
2438     'select_enum' => [ 'none', 'username', 'username@domain', 'disabled' ],
2439   },
2440
2441   {
2442     'key'         => 'global_unique-phonenum',
2443     'section'     => '',
2444     '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.',
2445     'type'        => 'select',
2446     'select_enum' => [ 'none', 'countrycode+phonenum', 'disabled' ],
2447   },
2448
2449   {
2450     'key'         => 'global_unique-pbx_title',
2451     'section'     => '',
2452     'description' => 'Global phone number uniqueness control: none (check uniqueness per exports), enabled (check across all services), or disabled (no duplicate checking).',
2453     'type'        => 'select',
2454     'select_enum' => [ 'enabled', 'disabled' ],
2455   },
2456
2457   {
2458     'key'         => 'global_unique-pbx_id',
2459     'section'     => '',
2460     'description' => 'Global PBX id uniqueness control: none (check uniqueness per exports), enabled (check across all services), or disabled (no duplicate checking).',
2461     'type'        => 'select',
2462     'select_enum' => [ 'enabled', 'disabled' ],
2463   },
2464
2465   {
2466     'key'         => 'svc_external-skip_manual',
2467     'section'     => 'UI',
2468     '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).',
2469     'type'        => 'checkbox',
2470   },
2471
2472   {
2473     'key'         => 'svc_external-display_type',
2474     'section'     => 'UI',
2475     'description' => 'Select a specific svc_external type to enable some UI changes specific to that type (i.e. artera_turbo).',
2476     'type'        => 'select',
2477     'select_enum' => [ 'generic', 'artera_turbo', ],
2478   },
2479
2480   {
2481     'key'         => 'ticket_system',
2482     'section'     => '',
2483     '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:1.7:Documentation:RT_Installation">integrated ticketing installation instructions</a>).   <b>RT_External</b> accesses an external RT installation in a separate database (local or remote).',
2484     'type'        => 'select',
2485     #'select_enum' => [ '', qw(RT_Internal RT_Libs RT_External) ],
2486     'select_enum' => [ '', qw(RT_Internal RT_External) ],
2487   },
2488
2489   {
2490     'key'         => 'ticket_system-default_queueid',
2491     'section'     => '',
2492     'description' => 'Default queue used when creating new customer tickets.',
2493     'type'        => 'select-sub',
2494     'options_sub' => sub {
2495                            my $conf = new FS::Conf;
2496                            if ( $conf->config('ticket_system') ) {
2497                              eval "use FS::TicketSystem;";
2498                              die $@ if $@;
2499                              FS::TicketSystem->queues();
2500                            } else {
2501                              ();
2502                            }
2503                          },
2504     'option_sub'  => sub {
2505                            my $conf = new FS::Conf;
2506                            if ( $conf->config('ticket_system') ) {
2507                              eval "use FS::TicketSystem;";
2508                              die $@ if $@;
2509                              FS::TicketSystem->queue(shift);
2510                            } else {
2511                              '';
2512                            }
2513                          },
2514   },
2515   {
2516     'key'         => 'ticket_system-force_default_queueid',
2517     'section'     => '',
2518     'description' => 'Disallow queue selection when creating new tickets from customer view.',
2519     'type'        => 'checkbox',
2520   },
2521   {
2522     'key'         => 'ticket_system-selfservice_queueid',
2523     'section'     => '',
2524     'description' => 'Queue used when creating new customer tickets from self-service.  Defautls to ticket_system-default_queueid if not specified.',
2525     #false laziness w/above
2526     'type'        => 'select-sub',
2527     'options_sub' => sub {
2528                            my $conf = new FS::Conf;
2529                            if ( $conf->config('ticket_system') ) {
2530                              eval "use FS::TicketSystem;";
2531                              die $@ if $@;
2532                              FS::TicketSystem->queues();
2533                            } else {
2534                              ();
2535                            }
2536                          },
2537     'option_sub'  => sub {
2538                            my $conf = new FS::Conf;
2539                            if ( $conf->config('ticket_system') ) {
2540                              eval "use FS::TicketSystem;";
2541                              die $@ if $@;
2542                              FS::TicketSystem->queue(shift);
2543                            } else {
2544                              '';
2545                            }
2546                          },
2547   },
2548
2549   {
2550     'key'         => 'ticket_system-priority_reverse',
2551     'section'     => '',
2552     '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.',
2553     'type'        => 'checkbox',
2554   },
2555
2556   {
2557     'key'         => 'ticket_system-custom_priority_field',
2558     'section'     => '',
2559     'description' => 'Custom field from the ticketing system to use as a custom priority classification.',
2560     'type'        => 'text',
2561   },
2562
2563   {
2564     'key'         => 'ticket_system-custom_priority_field-values',
2565     'section'     => '',
2566     'description' => 'Values for the custom field from the ticketing system to break down and sort customer ticket lists.',
2567     'type'        => 'textarea',
2568   },
2569
2570   {
2571     'key'         => 'ticket_system-custom_priority_field_queue',
2572     'section'     => '',
2573     'description' => 'Ticketing system queue in which the custom field specified in ticket_system-custom_priority_field is located.',
2574     'type'        => 'text',
2575   },
2576
2577   {
2578     'key'         => 'ticket_system-escalation',
2579     'section'     => '',
2580     'description' => 'Enable priority escalation of tickets as part of daily batch processing.',
2581     'type'        => 'checkbox',
2582   },
2583
2584   {
2585     'key'         => 'ticket_system-rt_external_datasrc',
2586     'section'     => '',
2587     '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>',
2588     'type'        => 'text',
2589
2590   },
2591
2592   {
2593     'key'         => 'ticket_system-rt_external_url',
2594     'section'     => '',
2595     'description' => 'With external RT integration, the URL for the external RT installation, for example, <code>https://rt.example.com/rt</code>',
2596     'type'        => 'text',
2597   },
2598
2599   {
2600     'key'         => 'company_name',
2601     'section'     => 'required',
2602     'description' => 'Your company name',
2603     'type'        => 'text',
2604     'per_agent'   => 1, #XXX just FS/FS/ClientAPI/Signup.pm
2605   },
2606
2607   {
2608     'key'         => 'company_address',
2609     'section'     => 'required',
2610     'description' => 'Your company address',
2611     'type'        => 'textarea',
2612     'per_agent'   => 1,
2613   },
2614
2615   {
2616     'key'         => 'echeck-void',
2617     'section'     => 'deprecated',
2618     'description' => '<B>DEPRECATED</B>, now controlled by ACLs.  Used to enable local-only voiding of echeck payments in addition to refunds against the payment gateway',
2619     'type'        => 'checkbox',
2620   },
2621
2622   {
2623     'key'         => 'cc-void',
2624     'section'     => 'deprecated',
2625     'description' => '<B>DEPRECATED</B>, now controlled by ACLs.  Used to enable local-only voiding of credit card payments in addition to refunds against the payment gateway',
2626     'type'        => 'checkbox',
2627   },
2628
2629   {
2630     'key'         => 'unvoid',
2631     'section'     => 'deprecated',
2632     'description' => '<B>DEPRECATED</B>, now controlled by ACLs.  Used to enable unvoiding of voided payments',
2633     'type'        => 'checkbox',
2634   },
2635
2636   {
2637     'key'         => 'address1-search',
2638     'section'     => 'UI',
2639     '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.',
2640     'type'        => 'checkbox',
2641   },
2642
2643   {
2644     'key'         => 'address2-search',
2645     'section'     => 'UI',
2646     'description' => 'Enable a "Unit" search box which searches the second address field.  Useful for multi-tenant applications.  See also: cust_main-require_address2',
2647     'type'        => 'checkbox',
2648   },
2649
2650   {
2651     'key'         => 'cust_main-require_address2',
2652     'section'     => 'UI',
2653     'description' => 'Second address field is required (on service address only, if billing and service addresses differ).  Also enables "Unit" labeling of address2 on customer view and edit pages.  Useful for multi-tenant applications.  See also: address2-search',
2654     'type'        => 'checkbox',
2655   },
2656
2657   {
2658     'key'         => 'agent-ship_address',
2659     'section'     => '',
2660     '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.",
2661     'type'        => 'checkbox',
2662   },
2663
2664   { 'key'         => 'referral_credit',
2665     'section'     => 'deprecated',
2666     'description' => "Used to enable one-time referral credits in the amount of one month <i>referred</i> customer's recurring fee (irregardless of frequency).  Replace with a billing event on appropriate packages.",
2667     'type'        => 'checkbox',
2668   },
2669
2670   { 'key'         => 'selfservice_server-cache_module',
2671     'section'     => 'self-service',
2672     '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.',
2673     'type'        => 'select',
2674     'select_enum' => [ 'Cache::SharedMemoryCache', 'Cache::FileCache', ], # '_Database' ],
2675   },
2676
2677   {
2678     'key'         => 'hylafax',
2679     'section'     => 'billing',
2680     '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).',
2681     'type'        => [qw( checkbox textarea )],
2682   },
2683
2684   {
2685     'key'         => 'cust_bill-ftpformat',
2686     'section'     => 'invoicing',
2687     'description' => 'Enable FTP of raw invoice data - format.',
2688     'type'        => 'select',
2689     'select_enum' => [ '', 'default', 'billco', ],
2690   },
2691
2692   {
2693     'key'         => 'cust_bill-ftpserver',
2694     'section'     => 'invoicing',
2695     'description' => 'Enable FTP of raw invoice data - server.',
2696     'type'        => 'text',
2697   },
2698
2699   {
2700     'key'         => 'cust_bill-ftpusername',
2701     'section'     => 'invoicing',
2702     'description' => 'Enable FTP of raw invoice data - server.',
2703     'type'        => 'text',
2704   },
2705
2706   {
2707     'key'         => 'cust_bill-ftppassword',
2708     'section'     => 'invoicing',
2709     'description' => 'Enable FTP of raw invoice data - server.',
2710     'type'        => 'text',
2711   },
2712
2713   {
2714     'key'         => 'cust_bill-ftpdir',
2715     'section'     => 'invoicing',
2716     'description' => 'Enable FTP of raw invoice data - server.',
2717     'type'        => 'text',
2718   },
2719
2720   {
2721     'key'         => 'cust_bill-spoolformat',
2722     'section'     => 'invoicing',
2723     'description' => 'Enable spooling of raw invoice data - format.',
2724     'type'        => 'select',
2725     'select_enum' => [ '', 'default', 'billco', ],
2726   },
2727
2728   {
2729     'key'         => 'cust_bill-spoolagent',
2730     'section'     => 'invoicing',
2731     'description' => 'Enable per-agent spooling of raw invoice data.',
2732     'type'        => 'checkbox',
2733   },
2734
2735   {
2736     'key'         => 'svc_acct-usage_suspend',
2737     'section'     => 'billing',
2738     '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.',
2739     'type'        => 'checkbox',
2740   },
2741
2742   {
2743     'key'         => 'svc_acct-usage_unsuspend',
2744     'section'     => 'billing',
2745     '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.',
2746     'type'        => 'checkbox',
2747   },
2748
2749   {
2750     'key'         => 'svc_acct-usage_threshold',
2751     'section'     => 'billing',
2752     '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.',
2753     'type'        => 'text',
2754   },
2755
2756   {
2757     'key'         => 'overlimit_groups',
2758     'section'     => '',
2759     'description' => 'RADIUS group (or comma-separated groups) to assign to svc_acct which has exceeded its bandwidth or time limit.',
2760     'type'        => 'text',
2761     'per_agent'   => 1,
2762   },
2763
2764   {
2765     'key'         => 'cust-fields',
2766     'section'     => 'UI',
2767     'description' => 'Which customer fields to display on reports by default',
2768     'type'        => 'select',
2769     'select_hash' => [ FS::ConfDefaults->cust_fields_avail() ],
2770   },
2771
2772   {
2773     'key'         => 'cust_pkg-display_times',
2774     'section'     => 'UI',
2775     'description' => 'Display full timestamps (not just dates) for customer packages.  Useful if you are doing real-time things like hourly prepaid.',
2776     'type'        => 'checkbox',
2777   },
2778
2779   {
2780     'key'         => 'cust_pkg-always_show_location',
2781     'section'     => 'UI',
2782     'description' => "Always display package locations, even when they're all the default service address.",
2783     'type'        => 'checkbox',
2784   },
2785
2786   {
2787     'key'         => 'cust_pkg-group_by_location',
2788     'section'     => 'UI',
2789     'description' => "Group packages by location.",
2790     'type'        => 'checkbox',
2791   },
2792
2793   {
2794     'key'         => 'cust_pkg-show_fcc_voice_grade_equivalent',
2795     'section'     => 'UI',
2796     'description' => "Show a field on package definitions for assigning a DSO equivalency number suitable for use on FCC form 477.",
2797     'type'        => 'checkbox',
2798   },
2799
2800   {
2801     'key'         => 'cust_pkg-large_pkg_size',
2802     'section'     => 'UI',
2803     'description' => "In customer view, summarize packages with more than this many services.  Set to zero to never summarize packages.",
2804     'type'        => 'text',
2805   },
2806
2807   {
2808     'key'         => 'svc_acct-edit_uid',
2809     'section'     => 'shell',
2810     'description' => 'Allow UID editing.',
2811     'type'        => 'checkbox',
2812   },
2813
2814   {
2815     'key'         => 'svc_acct-edit_gid',
2816     'section'     => 'shell',
2817     'description' => 'Allow GID editing.',
2818     'type'        => 'checkbox',
2819   },
2820
2821   {
2822     'key'         => 'zone-underscore',
2823     'section'     => 'BIND',
2824     'description' => 'Allow underscores in zone names.  As underscores are illegal characters in zone names, this option is not recommended.',
2825     'type'        => 'checkbox',
2826   },
2827
2828   {
2829     'key'         => 'echeck-nonus',
2830     'section'     => 'billing',
2831     'description' => 'Disable ABA-format account checking for Electronic Check payment info',
2832     'type'        => 'checkbox',
2833   },
2834
2835   {
2836     'key'         => 'voip-cust_cdr_spools',
2837     'section'     => 'telephony',
2838     'description' => 'Enable the per-customer option for individual CDR spools.',
2839     'type'        => 'checkbox',
2840   },
2841
2842   {
2843     'key'         => 'voip-cust_cdr_squelch',
2844     'section'     => 'telephony',
2845     'description' => 'Enable the per-customer option for not printing CDR on invoices.',
2846     'type'        => 'checkbox',
2847   },
2848
2849   {
2850     'key'         => 'voip-cdr_email',
2851     'section'     => 'telephony',
2852     'description' => 'Include the call details on emailed invoices (and HTML invoices viewed in the backend), even if the customer is configured for not printing them on the invoices.',
2853     'type'        => 'checkbox',
2854   },
2855
2856   {
2857     'key'         => 'voip-cust_email_csv_cdr',
2858     'section'     => 'telephony',
2859     'description' => 'Enable the per-customer option for including CDR information as a CSV attachment on emailed invoices.',
2860     'type'        => 'checkbox',
2861   },
2862
2863   {
2864     'key'         => 'cgp_rule-domain_templates',
2865     'section'     => '',
2866     'description' => 'Communigate Pro rule templates for domains, one per line, "svcnum Name"',
2867     'type'        => 'textarea',
2868   },
2869
2870   {
2871     'key'         => 'svc_forward-no_srcsvc',
2872     'section'     => '',
2873     '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.",
2874     'type'        => 'checkbox',
2875   },
2876
2877   {
2878     'key'         => 'svc_forward-arbitrary_dst',
2879     'section'     => '',
2880     '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.",
2881     'type'        => 'checkbox',
2882   },
2883
2884   {
2885     'key'         => 'tax-ship_address',
2886     'section'     => 'billing',
2887     'description' => 'By default, tax calculations are done based on the billing address.  Enable this switch to calculate tax based on the shipping address instead.',
2888     'type'        => 'checkbox',
2889   }
2890 ,
2891   {
2892     'key'         => 'tax-pkg_address',
2893     'section'     => 'billing',
2894     '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).',
2895     'type'        => 'checkbox',
2896   },
2897
2898   {
2899     'key'         => 'invoice-ship_address',
2900     'section'     => 'invoicing',
2901     'description' => 'Include the shipping address on invoices.',
2902     'type'        => 'checkbox',
2903   },
2904
2905   {
2906     'key'         => 'invoice-unitprice',
2907     'section'     => 'invoicing',
2908     'description' => 'Enable unit pricing on invoices.',
2909     'type'        => 'checkbox',
2910   },
2911
2912   {
2913     'key'         => 'invoice-smallernotes',
2914     'section'     => 'invoicing',
2915     'description' => 'Display the notes section in a smaller font on invoices.',
2916     'type'        => 'checkbox',
2917   },
2918
2919   {
2920     'key'         => 'invoice-smallerfooter',
2921     'section'     => 'invoicing',
2922     'description' => 'Display footers in a smaller font on invoices.',
2923     'type'        => 'checkbox',
2924   },
2925
2926   {
2927     'key'         => 'postal_invoice-fee_pkgpart',
2928     'section'     => 'billing',
2929     'description' => 'This allows selection of a package to insert on invoices for customers with postal invoices selected.',
2930     'type'        => 'select-part_pkg',
2931   },
2932
2933   {
2934     'key'         => 'postal_invoice-recurring_only',
2935     'section'     => 'billing',
2936     'description' => 'The postal invoice fee is omitted on invoices without reucrring charges when this is set.',
2937     'type'        => 'checkbox',
2938   },
2939
2940   {
2941     'key'         => 'batch-enable',
2942     'section'     => 'deprecated', #make sure batch-enable_payby is set for
2943                                    #everyone before removing
2944     'description' => 'Enable credit card and/or ACH batching - leave disabled for real-time installations.',
2945     'type'        => 'checkbox',
2946   },
2947
2948   {
2949     'key'         => 'batch-enable_payby',
2950     'section'     => 'billing',
2951     'description' => 'Enable batch processing for the specified payment types.',
2952     'type'        => 'selectmultiple',
2953     'select_enum' => [qw( CARD CHEK )],
2954   },
2955
2956   {
2957     'key'         => 'realtime-disable_payby',
2958     'section'     => 'billing',
2959     'description' => 'Disable realtime processing for the specified payment types.',
2960     'type'        => 'selectmultiple',
2961     'select_enum' => [qw( CARD CHEK )],
2962   },
2963
2964   {
2965     'key'         => 'batch-default_format',
2966     'section'     => 'billing',
2967     'description' => 'Default format for batches.',
2968     'type'        => 'select',
2969     'select_enum' => [ 'csv-td_canada_trust-merchant_pc_batch',
2970                        'csv-chase_canada-E-xactBatch', 'BoM', 'PAP',
2971                        'paymentech', 'ach-spiritone', 'RBC'
2972                     ]
2973   },
2974
2975   #lists could be auto-generated from pay_batch info
2976   {
2977     'key'         => 'batch-fixed_format-CARD',
2978     'section'     => 'billing',
2979     'description' => 'Fixed (unchangeable) format for credit card batches.',
2980     'type'        => 'select',
2981     'select_enum' => [ 'csv-td_canada_trust-merchant_pc_batch', 'BoM', 'PAP' ,
2982                        'csv-chase_canada-E-xactBatch', 'paymentech' ]
2983   },
2984
2985   {
2986     'key'         => 'batch-fixed_format-CHEK',
2987     'section'     => 'billing',
2988     'description' => 'Fixed (unchangeable) format for electronic check batches.',
2989     'type'        => 'select',
2990     'select_enum' => [ 'csv-td_canada_trust-merchant_pc_batch', 'BoM', 'PAP',
2991                        'paymentech', 'ach-spiritone', 'RBC', 'td_eft1464'
2992                      ]
2993   },
2994
2995   {
2996     'key'         => 'batch-increment_expiration',
2997     'section'     => 'billing',
2998     'description' => 'Increment expiration date years in batches until cards are current.  Make sure this is acceptable to your batching provider before enabling.',
2999     'type'        => 'checkbox'
3000   },
3001
3002   {
3003     'key'         => 'batchconfig-BoM',
3004     'section'     => 'billing',
3005     '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',
3006     'type'        => 'textarea',
3007   },
3008
3009   {
3010     'key'         => 'batchconfig-PAP',
3011     'section'     => 'billing',
3012     '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',
3013     'type'        => 'textarea',
3014   },
3015
3016   {
3017     'key'         => 'batchconfig-csv-chase_canada-E-xactBatch',
3018     'section'     => 'billing',
3019     'description' => 'Gateway ID for Chase Canada E-xact batching',
3020     'type'        => 'text',
3021   },
3022
3023   {
3024     'key'         => 'batchconfig-paymentech',
3025     'section'     => 'billing',
3026     'description' => 'Configuration for Chase Paymentech batching, five lines: 1. BIN, 2. Terminal ID, 3. Merchant ID, 4. Username, 5. Password (for batch uploads)',
3027     'type'        => 'textarea',
3028   },
3029
3030   {
3031     'key'         => 'batchconfig-RBC',
3032     'section'     => 'billing',
3033     'description' => 'Configuration for Royal Bank of Canada PDS batching, four lines: 1. Client number, 2. Short name, 3. Long name, 4. Transaction code.',
3034     'type'        => 'textarea',
3035   },
3036
3037   {
3038     'key'         => 'batchconfig-td_eft1464',
3039     'section'     => 'billing',
3040     '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.',
3041     'type'        => 'textarea',
3042   },
3043
3044   {
3045     'key'         => 'batch-manual_approval',
3046     'section'     => 'billing',
3047     'description' => 'Allow manual batch closure, which will approve all payments that do not yet have a status.  This is not advised, but is needed for payment processors that provide a report of rejected rather than approved payments.',
3048     'type'        => 'checkbox',
3049   },
3050
3051   {
3052     'key'         => 'payment_history-years',
3053     'section'     => 'UI',
3054     'description' => 'Number of years of payment history to show by default.  Currently defaults to 2.',
3055     'type'        => 'text',
3056   },
3057
3058   {
3059     'key'         => 'change_history-years',
3060     'section'     => 'UI',
3061     'description' => 'Number of years of change history to show by default.  Currently defaults to 0.5.',
3062     'type'        => 'text',
3063   },
3064
3065   {
3066     'key'         => 'cust_main-packages-years',
3067     'section'     => 'UI',
3068     'description' => 'Number of years to show old (cancelled and one-time charge) packages by default.  Currently defaults to 2.',
3069     'type'        => 'text',
3070   },
3071
3072   {
3073     'key'         => 'cust_main-use_comments',
3074     'section'     => 'UI',
3075     'description' => 'Display free form comments on the customer edit screen.  Useful as a scratch pad.',
3076     'type'        => 'checkbox',
3077   },
3078
3079   {
3080     'key'         => 'cust_main-disable_notes',
3081     'section'     => 'UI',
3082     'description' => 'Disable new style customer notes - timestamped and user identified customer notes.  Useful in tracking who did what.',
3083     'type'        => 'checkbox',
3084   },
3085
3086   {
3087     'key'         => 'cust_main_note-display_times',
3088     'section'     => 'UI',
3089     'description' => 'Display full timestamps (not just dates) for customer notes.',
3090     'type'        => 'checkbox',
3091   },
3092
3093   {
3094     'key'         => 'cust_main-ticket_statuses',
3095     'section'     => 'UI',
3096     'description' => 'Show tickets with these statuses on the customer view page.',
3097     'type'        => 'selectmultiple',
3098     'select_enum' => [qw( new open stalled resolved rejected deleted )],
3099   },
3100
3101   {
3102     'key'         => 'cust_main-max_tickets',
3103     'section'     => 'UI',
3104     'description' => 'Maximum number of tickets to show on the customer view page.',
3105     'type'        => 'text',
3106   },
3107
3108   {
3109     'key'         => 'cust_main-skeleton_tables',
3110     'section'     => '',
3111     'description' => 'Tables which will have skeleton records inserted into them for each customer.  Syntax for specifying tables is unfortunately a tricky perl data structure for now.',
3112     'type'        => 'textarea',
3113   },
3114
3115   {
3116     'key'         => 'cust_main-skeleton_custnum',
3117     'section'     => '',
3118     'description' => 'Customer number specifying the source data to copy into skeleton tables for new customers.',
3119     'type'        => 'text',
3120   },
3121
3122   {
3123     'key'         => 'cust_main-enable_birthdate',
3124     'section'     => 'UI',
3125     'descritpion' => 'Enable tracking of a birth date with each customer record',
3126     'type'        => 'checkbox',
3127   },
3128
3129   {
3130     'key'         => 'support-key',
3131     'section'     => '',
3132     'description' => 'A support key enables access to commercial services delivered over the network, such as the payroll module, access to the internal ticket system, priority support and optional backups.',
3133     'type'        => 'text',
3134   },
3135
3136   {
3137     'key'         => 'card-types',
3138     'section'     => 'billing',
3139     'description' => 'Select one or more card types to enable only those card types.  If no card types are selected, all card types are available.',
3140     'type'        => 'selectmultiple',
3141     'select_enum' => \@card_types,
3142   },
3143
3144   {
3145     'key'         => 'disable-fuzzy',
3146     'section'     => 'UI',
3147     'description' => 'Disable fuzzy searching.  Speeds up searching for large sites, but only shows exact matches.',
3148     'type'        => 'checkbox',
3149   },
3150
3151   { 'key'         => 'pkg_referral',
3152     'section'     => '',
3153     'description' => 'Enable package-specific advertising sources.',
3154     'type'        => 'checkbox',
3155   },
3156
3157   { 'key'         => 'pkg_referral-multiple',
3158     'section'     => '',
3159     'description' => 'In addition, allow multiple advertising sources to be associated with a single package.',
3160     'type'        => 'checkbox',
3161   },
3162
3163   {
3164     'key'         => 'dashboard-install_welcome',
3165     'section'     => 'UI',
3166     'description' => 'New install welcome screen.',
3167     'type'        => 'select',
3168     'select_enum' => [ '', 'ITSP_fsinc_hosted', ],
3169   },
3170
3171   {
3172     'key'         => 'dashboard-toplist',
3173     'section'     => 'UI',
3174     'description' => 'List of items to display on the top of the front page',
3175     'type'        => 'textarea',
3176   },
3177
3178   {
3179     'key'         => 'impending_recur_msgnum',
3180     'section'     => 'notification',
3181     'description' => 'Template to use for alerts about first-time recurring billing.',
3182     %msg_template_options,
3183   },
3184
3185   {
3186     'key'         => 'impending_recur_template',
3187     'section'     => 'deprecated',
3188     'description' => 'Template file for alerts about looming first time recurrant billing.  See the <a href="http://search.cpan.org/dist/Text-Template/lib/Text/Template.pm">Text::Template</a> documentation for details on the template substitition language.  Also see packages with a <a href="../browse/part_pkg.cgi">flat price plan</a>  The following variables are available<ul><li><code>$packages</code> allowing <code>$packages->[0]</code> thru <code>$packages->[n]</code> <li><code>$package</code> the first package, same as <code>$packages->[0]</code> <li><code>$recurdates</code> allowing <code>$recurdates->[0]</code> thru <code>$recurdates->[n]</code> <li><code>$recurdate</code> the first recurdate, same as <code>$recurdate->[0]</code> <li><code>$first</code> <li><code>$last</code></ul>',
3189 # <li><code>$payby</code> <li><code>$expdate</code> most likely only confuse
3190     'type'        => 'textarea',
3191   },
3192
3193   {
3194     'key'         => 'logo.png',
3195     'section'     => 'UI',  #'invoicing' ?
3196     'description' => 'Company logo for HTML invoices and the backoffice interface, in PNG format.  Suggested size somewhere near 92x62.',
3197     'type'        => 'image',
3198     'per_agent'   => 1, #XXX just view/logo.cgi, which is for the global
3199                         #old-style editor anyway...?
3200   },
3201
3202   {
3203     'key'         => 'logo.eps',
3204     'section'     => 'invoicing',
3205     'description' => 'Company logo for printed and PDF invoices, in EPS format.',
3206     'type'        => 'image',
3207     'per_agent'   => 1, #XXX as above, kinda
3208   },
3209
3210   {
3211     'key'         => 'selfservice-ignore_quantity',
3212     'section'     => 'self-service',
3213     'description' => 'Ignores service quantity restrictions in self-service context.  Strongly not recommended - just set your quantities correctly in the first place.',
3214     'type'        => 'checkbox',
3215   },
3216
3217   {
3218     'key'         => 'selfservice-session_timeout',
3219     'section'     => 'self-service',
3220     'description' => 'Self-service session timeout.  Defaults to 1 hour.',
3221     'type'        => 'select',
3222     'select_enum' => [ '1 hour', '2 hours', '4 hours', '8 hours', '1 day', '1 week', ],
3223   },
3224
3225   {
3226     'key'         => 'disable_setup_suspended_pkgs',
3227     'section'     => 'billing',
3228     'description' => 'Disables charging of setup fees for suspended packages.',
3229     'type'        => 'checkbox',
3230   },
3231
3232   {
3233     'key'         => 'password-generated-allcaps',
3234     'section'     => 'password',
3235     'description' => 'Causes passwords automatically generated to consist entirely of capital letters',
3236     'type'        => 'checkbox',
3237   },
3238
3239   {
3240     'key'         => 'datavolume-forcemegabytes',
3241     'section'     => 'UI',
3242     'description' => 'All data volumes are expressed in megabytes',
3243     'type'        => 'checkbox',
3244   },
3245
3246   {
3247     'key'         => 'datavolume-significantdigits',
3248     'section'     => 'UI',
3249     'description' => 'number of significant digits to use to represent data volumes',
3250     'type'        => 'text',
3251   },
3252
3253   {
3254     'key'         => 'disable_void_after',
3255     'section'     => 'billing',
3256     'description' => 'Number of seconds after which freeside won\'t attempt to VOID a payment first when performing a refund.',
3257     'type'        => 'text',
3258   },
3259
3260   {
3261     'key'         => 'disable_line_item_date_ranges',
3262     'section'     => 'billing',
3263     'description' => 'Prevent freeside from automatically generating date ranges on invoice line items.',
3264     'type'        => 'checkbox',
3265   },
3266
3267   {
3268     'key'         => 'support_packages',
3269     'section'     => '',
3270     '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...
3271     'type'        => 'select-part_pkg',
3272     'multiple'    => 1,
3273   },
3274
3275   {
3276     'key'         => 'cust_main-require_phone',
3277     'section'     => '',
3278     'description' => 'Require daytime or night phone for all customer records.',
3279     'type'        => 'checkbox',
3280   },
3281
3282   {
3283     'key'         => 'cust_main-require_invoicing_list_email',
3284     'section'     => '',
3285     'description' => 'Email address field is required: require at least one invoicing email address for all customer records.',
3286     'type'        => 'checkbox',
3287   },
3288
3289   {
3290     'key'         => 'svc_acct-display_paid_time_remaining',
3291     'section'     => '',
3292     'description' => 'Show paid time remaining in addition to time remaining.',
3293     'type'        => 'checkbox',
3294   },
3295
3296   {
3297     'key'         => 'cancel_credit_type',
3298     'section'     => 'billing',
3299     'description' => 'The group to use for new, automatically generated credit reasons resulting from cancellation.',
3300     'type'        => 'select-sub',
3301     'options_sub' => sub { require FS::Record;
3302                            require FS::reason_type;
3303                            map { $_->typenum => $_->type }
3304                                FS::Record::qsearch('reason_type', { class=>'R' } );
3305                          },
3306     'option_sub'  => sub { require FS::Record;
3307                            require FS::reason_type;
3308                            my $reason_type = FS::Record::qsearchs(
3309                              'reason_type', { 'typenum' => shift }
3310                            );
3311                            $reason_type ? $reason_type->type : '';
3312                          },
3313   },
3314
3315   {
3316     'key'         => 'referral_credit_type',
3317     'section'     => 'deprecated',
3318     'description' => 'Used to be the group to use for new, automatically generated credit reasons resulting from referrals.  Now set in a package billing event for the referral.',
3319     'type'        => 'select-sub',
3320     'options_sub' => sub { require FS::Record;
3321                            require FS::reason_type;
3322                            map { $_->typenum => $_->type }
3323                                FS::Record::qsearch('reason_type', { class=>'R' } );
3324                          },
3325     'option_sub'  => sub { require FS::Record;
3326                            require FS::reason_type;
3327                            my $reason_type = FS::Record::qsearchs(
3328                              'reason_type', { 'typenum' => shift }
3329                            );
3330                            $reason_type ? $reason_type->type : '';
3331                          },
3332   },
3333
3334   {
3335     'key'         => 'signup_credit_type',
3336     'section'     => 'billing', #self-service?
3337     'description' => 'The group to use for new, automatically generated credit reasons resulting from signup and self-service declines.',
3338     'type'        => 'select-sub',
3339     'options_sub' => sub { require FS::Record;
3340                            require FS::reason_type;
3341                            map { $_->typenum => $_->type }
3342                                FS::Record::qsearch('reason_type', { class=>'R' } );
3343                          },
3344     'option_sub'  => sub { require FS::Record;
3345                            require FS::reason_type;
3346                            my $reason_type = FS::Record::qsearchs(
3347                              'reason_type', { 'typenum' => shift }
3348                            );
3349                            $reason_type ? $reason_type->type : '';
3350                          },
3351   },
3352
3353   {
3354     'key'         => 'prepayment_discounts-credit_type',
3355     'section'     => 'billing',
3356     'description' => 'Enables the offering of prepayment discounts and establishes the credit reason type.',
3357     'type'        => 'select-sub',
3358     'options_sub' => sub { require FS::Record;
3359                            require FS::reason_type;
3360                            map { $_->typenum => $_->type }
3361                                FS::Record::qsearch('reason_type', { class=>'R' } );
3362                          },
3363     'option_sub'  => sub { require FS::Record;
3364                            require FS::reason_type;
3365                            my $reason_type = FS::Record::qsearchs(
3366                              'reason_type', { 'typenum' => shift }
3367                            );
3368                            $reason_type ? $reason_type->type : '';
3369                          },
3370
3371   },
3372
3373   {
3374     'key'         => 'cust_main-agent_custid-format',
3375     'section'     => '',
3376     'description' => 'Enables searching of various formatted values in cust_main.agent_custid',
3377     'type'        => 'select',
3378     'select_hash' => [
3379                        ''      => 'Numeric only',
3380                        '\d{7}' => 'Numeric only, exactly 7 digits',
3381                        'ww?d+' => 'Numeric with one or two letter prefix',
3382                      ],
3383   },
3384
3385   {
3386     'key'         => 'card_masking_method',
3387     'section'     => 'UI',
3388     '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.',
3389     'type'        => 'select',
3390     'select_hash' => [
3391                        ''            => '123456xxxxxx1234',
3392                        'first6last2' => '123456xxxxxxxx12',
3393                        'first4last4' => '1234xxxxxxxx1234',
3394                        'first4last2' => '1234xxxxxxxxxx12',
3395                        'first2last4' => '12xxxxxxxxxx1234',
3396                        'first2last2' => '12xxxxxxxxxxxx12',
3397                        'first0last4' => 'xxxxxxxxxxxx1234',
3398                        'first0last2' => 'xxxxxxxxxxxxxx12',
3399                      ],
3400   },
3401
3402   {
3403     'key'         => 'disable_previous_balance',
3404     'section'     => 'invoicing',
3405     'description' => 'Disable inclusion of previous balance, payment, and credit lines on invoices',
3406     'type'        => 'checkbox',
3407   },
3408
3409   {
3410     'key'         => 'previous_balance-exclude_from_total',
3411     'section'     => 'invoicing',
3412     'description' => 'Do not include previous balance in the \'Total\' line.  Only meaningful when invoice_sections is false.  Optionally provide text to override the Total New Charges description',
3413     'type'        => [ qw(checkbox text) ],
3414   },
3415
3416   {
3417     'key'         => 'previous_balance-summary_only',
3418     'section'     => 'invoicing',
3419     'description' => 'Only show a single line summarizing the total previous balance rather than one line per invoice.',
3420     'type'        => 'checkbox',
3421   },
3422
3423   {
3424     'key'         => 'balance_due_below_line',
3425     'section'     => 'invoicing',
3426     'description' => 'Place the balance due message below a line.  Only meaningful when when invoice_sections is false.',
3427     'type'        => 'checkbox',
3428   },
3429
3430   {
3431     'key'         => 'usps_webtools-userid',
3432     'section'     => 'UI',
3433     '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.',
3434     'type'        => 'text',
3435   },
3436
3437   {
3438     'key'         => 'usps_webtools-password',
3439     'section'     => 'UI',
3440     '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.',
3441     'type'        => 'text',
3442   },
3443
3444   {
3445     'key'         => 'cust_main-auto_standardize_address',
3446     'section'     => 'UI',
3447     'description' => 'When using USPS web tools, automatically standardize the address without asking.',
3448     'type'        => 'checkbox',
3449   },
3450
3451   {
3452     'key'         => 'cust_main-require_censustract',
3453     'section'     => 'UI',
3454     'description' => 'Customer is required to have a census tract.  Useful for FCC form 477 reports. See also: cust_main-auto_standardize_address',
3455     'type'        => 'checkbox',
3456   },
3457
3458   {
3459     'key'         => 'census_year',
3460     'section'     => 'UI',
3461     'description' => 'The year to use in census tract lookups',
3462     'type'        => 'select',
3463     'select_enum' => [ qw( 2010 2009 2008 ) ],
3464   },
3465
3466   {
3467     'key'         => 'company_latitude',
3468     'section'     => 'UI',
3469     'description' => 'Your company latitude (-90 through 90)',
3470     'type'        => 'text',
3471   },
3472
3473   {
3474     'key'         => 'company_longitude',
3475     'section'     => 'UI',
3476     'description' => 'Your company longitude (-180 thru 180)',
3477     'type'        => 'text',
3478   },
3479
3480   {
3481     'key'         => 'disable_acl_changes',
3482     'section'     => '',
3483     'description' => 'Disable all ACL changes, for demos.',
3484     'type'        => 'checkbox',
3485   },
3486
3487   {
3488     'key'         => 'disable_settings_changes',
3489     'section'     => '',
3490     'description' => 'Disable all settings changes, for demos, except for the usernames given in the comma-separated list.',
3491     'type'        => [qw( checkbox text )],
3492   },
3493
3494   {
3495     'key'         => 'cust_main-edit_agent_custid',
3496     'section'     => 'UI',
3497     'description' => 'Enable editing of the agent_custid field.',
3498     'type'        => 'checkbox',
3499   },
3500
3501   {
3502     'key'         => 'cust_main-default_agent_custid',
3503     'section'     => 'UI',
3504     'description' => 'Display the agent_custid field when available instead of the custnum field.',
3505     'type'        => 'checkbox',
3506   },
3507
3508   {
3509     'key'         => 'cust_main-title-display_custnum',
3510     'section'     => 'UI',
3511     'description' => 'Add the display_custom (agent_custid or custnum) to the title on customer view pages.',
3512     'type'        => 'checkbox',
3513   },
3514
3515   {
3516     'key'         => 'cust_bill-default_agent_invid',
3517     'section'     => 'UI',
3518     'description' => 'Display the agent_invid field when available instead of the invnum field.',
3519     'type'        => 'checkbox',
3520   },
3521
3522   {
3523     'key'         => 'cust_main-auto_agent_custid',
3524     'section'     => 'UI',
3525     'description' => 'Automatically assign an agent_custid - select format',
3526     'type'        => 'select',
3527     'select_hash' => [ '' => 'No',
3528                        '1YMMXXXXXXXX' => '1YMMXXXXXXXX',
3529                      ],
3530   },
3531
3532   {
3533     'key'         => 'cust_main-default_areacode',
3534     'section'     => 'UI',
3535     'description' => 'Default area code for customers.',
3536     'type'        => 'text',
3537   },
3538
3539   {
3540     'key'         => 'order_pkg-no_start_date',
3541     'section'     => 'UI',
3542     'description' => 'Don\'t set a default start date for new packages.',
3543     'type'        => 'checkbox',
3544   },
3545
3546   {
3547     'key'         => 'mcp_svcpart',
3548     'section'     => '',
3549     'description' => 'Master Control Program svcpart.  Leave this blank.',
3550     'type'        => 'text', #select-part_svc
3551   },
3552
3553   {
3554     'key'         => 'cust_bill-max_same_services',
3555     'section'     => 'invoicing',
3556     '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.',
3557     'type'        => 'text',
3558   },
3559
3560   {
3561     'key'         => 'cust_bill-consolidate_services',
3562     'section'     => 'invoicing',
3563     'description' => 'Consolidate service display into fewer lines on invoices rather than one per service.',
3564     'type'        => 'checkbox',
3565   },
3566
3567   {
3568     'key'         => 'suspend_email_admin',
3569     'section'     => '',
3570     'description' => 'Destination admin email address to enable suspension notices',
3571     'type'        => 'text',
3572   },
3573
3574   {
3575     'key'         => 'email_report-subject',
3576     'section'     => '',
3577     'description' => 'Subject for reports emailed by freeside-fetch.  Defaults to "Freeside report".',
3578     'type'        => 'text',
3579   },
3580
3581   {
3582     'key'         => 'selfservice-head',
3583     'section'     => 'self-service',
3584     'description' => 'HTML for the HEAD section of the self-service interface, typically used for LINK stylesheet tags',
3585     'type'        => 'textarea', #htmlarea?
3586     'per_agent'   => 1,
3587   },
3588
3589
3590   {
3591     'key'         => 'selfservice-body_header',
3592     'section'     => 'self-service',
3593     'description' => 'HTML header for the self-service interface',
3594     'type'        => 'textarea', #htmlarea?
3595     'per_agent'   => 1,
3596   },
3597
3598   {
3599     'key'         => 'selfservice-body_footer',
3600     'section'     => 'self-service',
3601     'description' => 'HTML footer for the self-service interface',
3602     'type'        => 'textarea', #htmlarea?
3603     'per_agent'   => 1,
3604   },
3605
3606
3607   {
3608     'key'         => 'selfservice-body_bgcolor',
3609     'section'     => 'self-service',
3610     'description' => 'HTML background color for the self-service interface, for example, #FFFFFF',
3611     'type'        => 'text',
3612     'per_agent'   => 1,
3613   },
3614
3615   {
3616     'key'         => 'selfservice-box_bgcolor',
3617     'section'     => 'self-service',
3618     'description' => 'HTML color for self-service interface input boxes, for example, #C0C0C0',
3619     'type'        => 'text',
3620     'per_agent'   => 1,
3621   },
3622
3623   {
3624     'key'         => 'selfservice-text_color',
3625     'section'     => 'self-service',
3626     'description' => 'HTML text color for the self-service interface, for example, #000000',
3627     'type'        => 'text',
3628     'per_agent'   => 1,
3629   },
3630
3631   {
3632     'key'         => 'selfservice-link_color',
3633     'section'     => 'self-service',
3634     'description' => 'HTML link color for the self-service interface, for example, #0000FF',
3635     'type'        => 'text',
3636     'per_agent'   => 1,
3637   },
3638
3639   {
3640     'key'         => 'selfservice-vlink_color',
3641     'section'     => 'self-service',
3642     'description' => 'HTML visited link color for the self-service interface, for example, #FF00FF',
3643     'type'        => 'text',
3644     'per_agent'   => 1,
3645   },
3646
3647   {
3648     'key'         => 'selfservice-hlink_color',
3649     'section'     => 'self-service',
3650     'description' => 'HTML hover link color for the self-service interface, for example, #808080',
3651     'type'        => 'text',
3652     'per_agent'   => 1,
3653   },
3654
3655   {
3656     'key'         => 'selfservice-alink_color',
3657     'section'     => 'self-service',
3658     'description' => 'HTML active (clicked) link color for the self-service interface, for example, #808080',
3659     'type'        => 'text',
3660     'per_agent'   => 1,
3661   },
3662
3663   {
3664     'key'         => 'selfservice-font',
3665     'section'     => 'self-service',
3666     'description' => 'HTML font CSS for the self-service interface, for example, 0.9em/1.5em Arial, Helvetica, Geneva, sans-serif',
3667     'type'        => 'text',
3668     'per_agent'   => 1,
3669   },
3670
3671   {
3672     'key'         => 'selfservice-title_color',
3673     'section'     => 'self-service',
3674     'description' => 'HTML color for the self-service title, for example, #000000',
3675     'type'        => 'text',
3676     'per_agent'   => 1,
3677   },
3678
3679   {
3680     'key'         => 'selfservice-title_align',
3681     'section'     => 'self-service',
3682     'description' => 'HTML alignment for the self-service title, for example, center',
3683     'type'        => 'text',
3684     'per_agent'   => 1,
3685   },
3686   {
3687     'key'         => 'selfservice-title_size',
3688     'section'     => 'self-service',
3689     'description' => 'HTML font size for the self-service title, for example, 3',
3690     'type'        => 'text',
3691     'per_agent'   => 1,
3692   },
3693
3694   {
3695     'key'         => 'selfservice-title_left_image',
3696     'section'     => 'self-service',
3697     'description' => 'Image used for the top of the menu in the self-service interface, in PNG format.',
3698     'type'        => 'image',
3699     'per_agent'   => 1,
3700   },
3701
3702   {
3703     'key'         => 'selfservice-title_right_image',
3704     'section'     => 'self-service',
3705     'description' => 'Image used for the top of the menu in the self-service interface, in PNG format.',
3706     'type'        => 'image',
3707     'per_agent'   => 1,
3708   },
3709
3710   {
3711     'key'         => 'selfservice-menu_skipblanks',
3712     'section'     => 'self-service',
3713     'description' => 'Skip blank (spacer) entries in the self-service menu',
3714     'type'        => 'checkbox',
3715     'per_agent'   => 1,
3716   },
3717
3718   {
3719     'key'         => 'selfservice-menu_skipheadings',
3720     'section'     => 'self-service',
3721     'description' => 'Skip the unclickable heading entries in the self-service menu',
3722     'type'        => 'checkbox',
3723     'per_agent'   => 1,
3724   },
3725
3726   {
3727     'key'         => 'selfservice-menu_bgcolor',
3728     'section'     => 'self-service',
3729     'description' => 'HTML color for the self-service menu, for example, #C0C0C0',
3730     'type'        => 'text',
3731     'per_agent'   => 1,
3732   },
3733
3734   {
3735     'key'         => 'selfservice-menu_fontsize',
3736     'section'     => 'self-service',
3737     'description' => 'HTML font size for the self-service menu, for example, -1',
3738     'type'        => 'text',
3739     'per_agent'   => 1,
3740   },
3741   {
3742     'key'         => 'selfservice-menu_nounderline',
3743     'section'     => 'self-service',
3744     'description' => 'Styles menu links in the self-service without underlining.',
3745     'type'        => 'checkbox',
3746     'per_agent'   => 1,
3747   },
3748
3749
3750   {
3751     'key'         => 'selfservice-menu_top_image',
3752     'section'     => 'self-service',
3753     'description' => 'Image used for the top of the menu in the self-service interface, in PNG format.',
3754     'type'        => 'image',
3755     'per_agent'   => 1,
3756   },
3757
3758   {
3759     'key'         => 'selfservice-menu_body_image',
3760     'section'     => 'self-service',
3761     'description' => 'Repeating image used for the body of the menu in the self-service interface, in PNG format.',
3762     'type'        => 'image',
3763     'per_agent'   => 1,
3764   },
3765
3766   {
3767     'key'         => 'selfservice-menu_bottom_image',
3768     'section'     => 'self-service',
3769     'description' => 'Image used for the bottom of the menu in the self-service interface, in PNG format.',
3770     'type'        => 'image',
3771     'per_agent'   => 1,
3772   },
3773
3774   {
3775     'key'         => 'selfservice-bulk_format',
3776     'section'     => 'deprecated',
3777     'description' => 'Parameter arrangement for selfservice bulk features',
3778     'type'        => 'select',
3779     'select_enum' => [ '', 'izoom-soap', 'izoom-ftp' ],
3780     'per_agent'   => 1,
3781   },
3782
3783   {
3784     'key'         => 'selfservice-bulk_ftp_dir',
3785     'section'     => 'deprecated',
3786     'description' => 'Enable bulk ftp provisioning in this folder',
3787     'type'        => 'text',
3788     'per_agent'   => 1,
3789   },
3790
3791   {
3792     'key'         => 'signup-no_company',
3793     'section'     => 'self-service',
3794     'description' => "Don't display a field for company name on signup.",
3795     'type'        => 'checkbox',
3796   },
3797
3798   {
3799     'key'         => 'signup-recommend_email',
3800     'section'     => 'self-service',
3801     'description' => 'Encourage the entry of an invoicing email address on signup.',
3802     'type'        => 'checkbox',
3803   },
3804
3805   {
3806     'key'         => 'signup-recommend_daytime',
3807     'section'     => 'self-service',
3808     'description' => 'Encourage the entry of a daytime phone number  invoicing email address on signup.',
3809     'type'        => 'checkbox',
3810   },
3811
3812   {
3813     'key'         => 'svc_phone-radius-default_password',
3814     'section'     => 'telephony',
3815     'description' => 'Default password when exporting svc_phone records to RADIUS',
3816     'type'        => 'text',
3817   },
3818
3819   {
3820     'key'         => 'svc_phone-allow_alpha_phonenum',
3821     'section'     => 'telephony',
3822     'description' => 'Allow letters in phone numbers.',
3823     'type'        => 'checkbox',
3824   },
3825
3826   {
3827     'key'         => 'svc_phone-domain',
3828     'section'     => 'telephony',
3829     'description' => 'Track an optional domain association with each phone service.',
3830     'type'        => 'checkbox',
3831   },
3832
3833   {
3834     'key'         => 'svc_phone-phone_name-max_length',
3835     'section'     => 'telephony',
3836     '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.',
3837     'type'        => 'text',
3838   },
3839
3840   {
3841     'key'         => 'svc_phone-lnp',
3842     'section'     => 'telephony',
3843     'description' => 'Enables Number Portability features for svc_phone',
3844     'type'        => 'checkbox',
3845   },
3846
3847   {
3848     'key'         => 'default_phone_countrycode',
3849     'section'     => '',
3850     'description' => 'Default countrcode',
3851     'type'        => 'text',
3852   },
3853
3854   {
3855     'key'         => 'cdr-charged_party-field',
3856     'section'     => 'telephony',
3857     'description' => 'Set the charged_party field of CDRs to this field.',
3858     'type'        => 'select-sub',
3859     'options_sub' => sub { my $fields = FS::cdr->table_info->{'fields'};
3860                            map { $_ => $fields->{$_}||$_ }
3861                            grep { $_ !~ /^(acctid|charged_party)$/ }
3862                            FS::Schema::dbdef->table('cdr')->columns;
3863                          },
3864     'option_sub'  => sub { my $f = shift;
3865                            FS::cdr->table_info->{'fields'}{$f} || $f;
3866                          },
3867   },
3868
3869   #probably deprecate in favor of cdr-charged_party-field above
3870   {
3871     'key'         => 'cdr-charged_party-accountcode',
3872     'section'     => 'telephony',
3873     'description' => 'Set the charged_party field of CDRs to the accountcode.',
3874     'type'        => 'checkbox',
3875   },
3876
3877   {
3878     'key'         => 'cdr-charged_party-accountcode-trim_leading_0s',
3879     'section'     => 'telephony',
3880     'description' => 'When setting the charged_party field of CDRs to the accountcode, trim any leading zeros.',
3881     'type'        => 'checkbox',
3882   },
3883
3884 #  {
3885 #    'key'         => 'cdr-charged_party-truncate_prefix',
3886 #    'section'     => '',
3887 #    'description' => 'If the charged_party field has this prefix, truncate it to the length in cdr-charged_party-truncate_length.',
3888 #    'type'        => 'text',
3889 #  },
3890 #
3891 #  {
3892 #    'key'         => 'cdr-charged_party-truncate_length',
3893 #    'section'     => '',
3894 #    'description' => 'If the charged_party field has the prefix in cdr-charged_party-truncate_prefix, truncate it to this length.',
3895 #    'type'        => 'text',
3896 #  },
3897
3898   {
3899     'key'         => 'cdr-charged_party_rewrite',
3900     'section'     => 'telephony',
3901     '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*.',
3902     'type'        => 'checkbox',
3903   },
3904
3905   {
3906     'key'         => 'cdr-taqua-da_rewrite',
3907     'section'     => '',
3908     '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.',
3909     'type'        => 'text',
3910   },
3911
3912   {
3913     'key'         => 'cust_pkg-show_autosuspend',
3914     'section'     => 'UI',
3915     'description' => 'Show package auto-suspend dates.  Use with caution for now; can slow down customer view for large insallations.',
3916     'type'        => 'checkbox',
3917   },
3918
3919   {
3920     'key'         => 'cdr-asterisk_forward_rewrite',
3921     'section'     => 'telephony',
3922     '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").',
3923     'type'        => 'checkbox',
3924   },
3925
3926   {
3927     'key'         => 'sg-multicustomer_hack',
3928     'section'     => '',
3929     'description' => "Don't use this.",
3930     'type'        => 'checkbox',
3931   },
3932
3933   {
3934     'key'         => 'sg-ping_username',
3935     'section'     => '',
3936     'description' => "Don't use this.",
3937     'type'        => 'text',
3938   },
3939
3940   {
3941     'key'         => 'sg-ping_password',
3942     'section'     => '',
3943     'description' => "Don't use this.",
3944     'type'        => 'text',
3945   },
3946
3947   {
3948     'key'         => 'sg-login_username',
3949     'section'     => '',
3950     'description' => "Don't use this.",
3951     'type'        => 'text',
3952   },
3953
3954   {
3955     'key'         => 'mc-outbound_packages',
3956     'section'     => '',
3957     'description' => "Don't use this.",
3958     'type'        => 'select-part_pkg',
3959     'multiple'    => 1,
3960   },
3961
3962   {
3963     'key'         => 'disable-cust-pkg_class',
3964     'section'     => 'UI',
3965     'description' => 'Disable the two-step dropdown for selecting package class and package, and return to the classic single dropdown.',
3966     'type'        => 'checkbox',
3967   },
3968
3969   {
3970     'key'         => 'queued-max_kids',
3971     'section'     => '',
3972     'description' => 'Maximum number of queued processes.  Defaults to 10.',
3973     'type'        => 'text',
3974   },
3975
3976   {
3977     'key'         => 'queued-sleep_time',
3978     'section'     => '',
3979     '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.',
3980     'type'        => 'text',
3981   },
3982
3983   {
3984     'key'         => 'cancelled_cust-noevents',
3985     'section'     => 'billing',
3986     'description' => "Don't run events for cancelled customers",
3987     'type'        => 'checkbox',
3988   },
3989
3990   {
3991     'key'         => 'agent-invoice_template',
3992     'section'     => 'invoicing',
3993     'description' => 'Enable display/edit of old-style per-agent invoice template selection',
3994     'type'        => 'checkbox',
3995   },
3996
3997   {
3998     'key'         => 'svc_broadband-manage_link',
3999     'section'     => 'UI',
4000     'description' => 'URL for svc_broadband "Manage Device" link.  The following substitutions are available: $ip_addr.',
4001     'type'        => 'text',
4002   },
4003
4004   #more fine-grained, service def-level control could be useful eventually?
4005   {
4006     'key'         => 'svc_broadband-allow_null_ip_addr',
4007     'section'     => '',
4008     'description' => '',
4009     'type'        => 'checkbox',
4010   },
4011
4012   {
4013     'key'         => 'tax-report_groups',
4014     'section'     => '',
4015     'description' => 'List of grouping possibilities for tax names on reports, one per line, "label op value" (op can be = or !=).',
4016     'type'        => 'textarea',
4017   },
4018
4019   {
4020     'key'         => 'tax-cust_exempt-groups',
4021     'section'     => '',
4022     '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).',
4023     'type'        => 'textarea',
4024   },
4025
4026   {
4027     'key'         => 'cust_main-default_view',
4028     'section'     => 'UI',
4029     'description' => 'Default customer view, for users who have not selected a default view in their preferences.',
4030     'type'        => 'select',
4031     'select_hash' => [
4032       #false laziness w/view/cust_main.cgi and pref/pref.html
4033       'basics'          => 'Basics',
4034       'notes'           => 'Notes',
4035       'tickets'         => 'Tickets',
4036       'packages'        => 'Packages',
4037       'payment_history' => 'Payment History',
4038       'change_history'  => 'Change History',
4039       'jumbo'           => 'Jumbo',
4040     ],
4041   },
4042
4043   {
4044     'key'         => 'enable_tax_adjustments',
4045     'section'     => 'billing',
4046     'description' => 'Enable the ability to add manual tax adjustments.',
4047     'type'        => 'checkbox',
4048   },
4049
4050   {
4051     'key'         => 'rt-crontool',
4052     'section'     => '',
4053     'description' => 'Enable the RT CronTool extension.',
4054     'type'        => 'checkbox',
4055   },
4056
4057   {
4058     'key'         => 'pkg-balances',
4059     'section'     => 'billing',
4060     'description' => 'Enable experimental package balances.  Not recommended for general use.',
4061     'type'        => 'checkbox',
4062   },
4063
4064   {
4065     'key'         => 'pkg-addon_classnum',
4066     'section'     => 'billing',
4067     'description' => 'Enable the ability to restrict additional package orders based on package class.',
4068     'type'        => 'checkbox',
4069   },
4070
4071   {
4072     'key'         => 'cust_main-edit_signupdate',
4073     'section'     => 'UI',
4074     'descritpion' => 'Enable manual editing of the signup date.',
4075     'type'        => 'checkbox',
4076   },
4077
4078   {
4079     'key'         => 'svc_acct-disable_access_number',
4080     'section'     => 'UI',
4081     'descritpion' => 'Disable access number selection.',
4082     'type'        => 'checkbox',
4083   },
4084
4085   {
4086     'key'         => 'cust_bill_pay_pkg-manual',
4087     'section'     => 'UI',
4088     'description' => 'Allow manual application of payments to line items.',
4089     'type'        => 'checkbox',
4090   },
4091
4092   {
4093     'key'         => 'cust_credit_bill_pkg-manual',
4094     'section'     => 'UI',
4095     'description' => 'Allow manual application of credits to line items.',
4096     'type'        => 'checkbox',
4097   },
4098
4099   {
4100     'key'         => 'breakage-days',
4101     'section'     => 'billing',
4102     '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.',
4103     'type'        => 'text',
4104     'per_agent'   => 1,
4105   },
4106
4107   {
4108     'key'         => 'breakage-pkg_class',
4109     'section'     => 'billing',
4110     'description' => 'Package class to use for breakage reconciliation.',
4111     'type'        => 'select-pkg_class',
4112   },
4113
4114   {
4115     'key'         => 'disable_cron_billing',
4116     'section'     => 'billing',
4117     '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.',
4118     'type'        => 'checkbox',
4119   },
4120
4121   {
4122     'key'         => 'svc_domain-edit_domain',
4123     'section'     => '',
4124     'description' => 'Enable domain renaming',
4125     'type'        => 'checkbox',
4126   },
4127
4128   {
4129     'key'         => 'enable_legacy_prepaid_income',
4130     'section'     => '',
4131     '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.",
4132     'type'        => 'checkbox',
4133   },
4134
4135   {
4136     'key'         => 'cust_main-exports',
4137     'section'     => '',
4138     'description' => 'Export(s) to call on cust_main insert, modification and deletion.',
4139     'type'        => 'select-sub',
4140     'multiple'    => 1,
4141     'options_sub' => sub {
4142       require FS::Record;
4143       require FS::part_export;
4144       my @part_export =
4145         map { qsearch( 'part_export', {exporttype => $_ } ) }
4146           keys %{FS::part_export::export_info('cust_main')};
4147       map { $_->exportnum => $_->exporttype.' to '.$_->machine } @part_export;
4148     },
4149     'option_sub'  => sub {
4150       require FS::Record;
4151       require FS::part_export;
4152       my $part_export = FS::Record::qsearchs(
4153         'part_export', { 'exportnum' => shift }
4154       );
4155       $part_export
4156         ? $part_export->exporttype.' to '.$part_export->machine
4157         : '';
4158     },
4159   },
4160
4161   {
4162     'key'         => 'cust_tag-location',
4163     'section'     => 'UI',
4164     'description' => 'Location where customer tags are displayed.',
4165     'type'        => 'select',
4166     'select_enum' => [ 'misc_info', 'top' ],
4167   },
4168
4169   {
4170     'key'         => 'maestro-status_test',
4171     'section'     => 'UI',
4172     'description' => 'Display a link to the maestro status test page on the customer view page',
4173     'type'        => 'checkbox',
4174   },
4175
4176   {
4177     'key'         => 'cust_main-custom_link',
4178     'section'     => 'UI',
4179     'description' => 'URL to use as source for the "Custom" tab in the View Customer page.  The custnum will be appended.',
4180     'type'        => 'text',
4181   },
4182
4183   {
4184     'key'         => 'cust_main-custom_title',
4185     'section'     => 'UI',
4186     'description' => 'Title for the "Custom" tab in the View Customer page.',
4187     'type'        => 'text',
4188   },
4189
4190   {
4191     'key'         => 'part_pkg-default_suspend_bill',
4192     'section'     => 'billing',
4193     'description' => 'Default the "Continue recurring billing while suspended" flag to on for new package definitions.',
4194     'type'        => 'checkbox',
4195   },
4196
4197   {
4198     'key'         => 'svc_acct-cf_privatekey-message',
4199     'section'     => '',
4200     'description' => 'For internal use: HTML displayed when cf_privatekey field is set.',
4201     'type'        => 'textarea',
4202   },
4203
4204   {
4205     'key'         => 'menu-prepend_links',
4206     'section'     => 'UI',
4207     'description' => 'Links to prepend to the main menu, one per line, with format "URL Link Label (optional ALT popup)".',
4208     'type'        => 'textarea',
4209   },
4210
4211   {
4212     'key'         => 'cust_main-external_links',
4213     'section'     => 'UI',
4214     'description' => 'External links available in customer view, one per line, with format "URL Link Label (optional ALT popup)".  The URL will have custnum appended.',
4215     'type'        => 'textarea',
4216   },
4217
4218   {
4219     'key'         => 'svc_phone-did-summary',
4220     'section'     => 'invoicing',
4221     'description' => 'Enable DID activity summary for past 30 days on invoices, showing # DIDs activated/deactivated/ported-in/ported-out and total minutes usage',
4222     'type'        => 'checkbox',
4223   },
4224
4225   {
4226     'key'         => 'opensips_gwlist',
4227     'section'     => 'telephony',
4228     'description' => 'For svc_phone OpenSIPS dr_rules export, gwlist column value, per-agent',
4229     'type'        => 'text',
4230     'per_agent'   => 1,
4231     'agentonly'   => 1,
4232   },
4233
4234   {
4235     'key'         => 'opensips_description',
4236     'section'     => 'telephony',
4237     'description' => 'For svc_phone OpenSIPS dr_rules export, description column value, per-agent',
4238     'type'        => 'text',
4239     'per_agent'   => 1,
4240     'agentonly'   => 1,
4241   },
4242
4243   {
4244     'key'         => 'opensips_route',
4245     'section'     => 'telephony',
4246     'description' => 'For svc_phone OpenSIPS dr_rules export, routeid column value, per-agent',
4247     'type'        => 'text',
4248     'per_agent'   => 1,
4249     'agentonly'   => 1,
4250   },
4251
4252   {
4253     'key'         => 'cust_bill-no_recipients-error',
4254     'section'     => 'invoicing',
4255     '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.',
4256     'type'        => 'checkbox',
4257   },
4258
4259   {
4260     'key'         => 'cust_main-status_module',
4261     'section'     => 'UI',
4262     'description' => 'Which module to use for customer status display.  The "Classic" module (the default) considers accounts with cancelled recurring packages but un-cancelled one-time charges Inactive.  The "Recurring" module considers those customers Cancelled.  Similarly for customers with suspended recurring packages but one-time charges.', #other differences?
4263     'type'        => 'select',
4264     'select_enum' => [ 'Classic', 'Recurring' ],
4265   },
4266
4267   {
4268     'key'         => 'note-classes',
4269     'section'     => 'UI',
4270     'description' => 'Use customer note classes',
4271     'type'        => 'select',
4272     'select_hash' => [
4273                        0 => 'Disabled',
4274                        1 => 'Enabled',
4275                        2 => 'Enabled, with tabs',
4276                      ],
4277   },
4278
4279   {
4280     'key'         => 'username-pound',
4281     'section'     => 'username',
4282     'description' => 'Allow the pound character (#) in usernames.',
4283     'type'        => 'checkbox',
4284   },
4285
4286   {
4287     'key'         => 'ie-compatibility_mode',
4288     'section'     => 'UI',
4289     '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.",
4290     'type'        => 'select',
4291     'select_enum' => [ '', '7', 'EmulateIE7', '8', 'EmulateIE8' ],
4292   },
4293
4294   { key => "apacheroot", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4295   { key => "apachemachine", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4296   { key => "apachemachines", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4297   { key => "bindprimary", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4298   { key => "bindsecondaries", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4299   { key => "bsdshellmachines", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4300   { key => "cyrus", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4301   { key => "cp_app", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4302   { key => "erpcdmachines", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4303   { key => "icradiusmachines", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4304   { key => "icradius_mysqldest", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4305   { key => "icradius_mysqlsource", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4306   { key => "icradius_secrets", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4307   { key => "maildisablecatchall", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4308   { key => "mxmachines", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4309   { key => "nsmachines", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4310   { key => "arecords", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4311   { key => "cnamerecords", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4312   { key => "nismachines", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4313   { key => "qmailmachines", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4314   { key => "radiusmachines", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4315   { key => "sendmailconfigpath", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4316   { key => "sendmailmachines", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4317   { key => "sendmailrestart", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4318   { key => "shellmachine", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4319   { key => "shellmachine-useradd", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4320   { key => "shellmachine-userdel", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4321   { key => "shellmachine-usermod", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4322   { key => "shellmachines", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4323   { key => "radiusprepend", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4324   { key => "textradiusprepend", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4325   { key => "username_policy", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4326   { key => "vpopmailmachines", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4327   { key => "vpopmailrestart", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4328   { key => "safe-part_pkg", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4329   { key => "selfservice_server-quiet", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4330   { key => "signup_server-quiet", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4331   { key => "signup_server-email", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4332   { key => "vonage-username", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4333   { key => "vonage-password", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4334   { key => "vonage-fromnumber", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4335
4336 );
4337
4338 1;
4339