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