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