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