Re: ... and now for something completely different: User Friendliness

[Wes Hardaker <wes@hardakers.net>]

>>>>> On Tue, 07 Jan 2003 06:23:31 +0100, Lars Magne Ingebrigtsen <larsi@gnus.org> said:

Lars> I didn't find any examples on the page as to what the config
Lars> generating language looks like -- do you have an example?

Oh, uh, yeah...  This is defined in perl structures:

add_primary('notification_destinations',
            title => "Setting up a notification receiver",
            sub_modules => 'target_addr',
            questions => [{ name => 'destination',
                            type => 'menu',
                            text => 'enter the notification destination',
                            # inline at-run-time value extraction
                            values => [\&net_policy_select,"select name from cli
ents"]
                          },
                          { name => 'snmpNotifyType',
                            text =>
                            'What type of notification do you want to send?',
                            type => 'radio',
                            values => [qw(1 2)],
                            labels => {'1' => 'trap',
                                       '2' => 'inform'}},
                          { name => 'SNMPVersion',
                            type => 'menu',
                            text => 'What version of the SNMP protocol should th
e notification be sent over?',
                            values => [qw(0 1 3)],
                            labels => {'0' => 'SNMP version 1',
                                       '1' => 'SNMP version 2c',
                                       '3' => 'SNMP version 3',
                                      }
                          }],
            post_answers => [
                             sub { my $wiz = shift;
                                   if (param(SNMPVersion) eq '3') {
                                       $wiz->add_late_todos('target_param_3');
                                   } else {
                                       $wiz->add_late_todos('target_param_commun
ity');
                                   }
                                   return 'OK';
                               }
                             ],
            actions_descr => ['Adding the notification receiver mapping'],
            actions => [[\&net_policy_sql,'insert into snmpNotifyTable(snmpNotif
yName,snmpNotifyTag,snmpNotifyType,snmpNotifyStorageType,snmpNotifyRowStatus) va
lues(@destination@,@destination@,@snmpNotifyType@,3,4)'],
                        'Adding the notification receiver']);

add_primary('target_addr',
            title => 'Configure the notification destination',
            questions =>
            [
             { text => "Timeout length",
               type => text,
               name => 'snmpTargetAddrTimeout',
               # default value:
               values => 1500 },
             { text => "Number of Retries",
               type => text,
               name => 'snmpTargetAddrRetryCount',
               values => 3 }
             { type => 'hidden',  # hard coded value
               name => 'snmpTargetAddrTAddress',
               # inline at-run-time value extraction
               values => [sub {my $x = net_policy_select('bogus','select ipaddr
from clients where name = @destination@');
                               $x->[0] .= "00A2";
                               return $x}] }
            ],
            actions => [[sub {do_something_with(param('snmpTargetAddrTimeout'));
                              #...}],
                       # prints to the users screen
                       'Configuring the notification receiver\'s address']);

I actually need to write the documentation for the module, but my
coworker needs that asap as well so it'll be done shortly.  Also,
ignore the net_policy_select and net_policy_sql functions referenced
above.  They're project specific.  This data will be hard to read
because you don't understand what it's trying to do (it's very SNMP
specific, which is certainly a protocol you don't likely grok).
-- 
"The trouble with having an open mind, of course, is that people will
 insist on coming along and trying to put things in it."   -- Terry Pratchett