Documentation/English (British)/developer-chapter1-users-add.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">\r
   2 <html>\r
   3         <head>\r
   4                 <link href="style.css" REL="stylesheet" TYPE="text/css" MEDIA="screen">\r
   5                 <meta http-equiv="Content-Type" content="text/html;charset=UTF-8">\r
   6                 <title>Xestia Scanner Server Documentation - Developer Documentation - 1.25 xestiascan_users_add</title>\r
   7         </head>\r
   8         <body>\r
   9                 <div class="menubarback">\r
  10                         <div class="menubar">\r
  11                                 <span class="apptitle">Xestia Scanner Server</span>\r
  12                                 <a href="index.html">Index</a> | <a href="user.html">User \r
  13 Documentation</a> | <a href="tutorial.html">Tutorial Documentation</a> | \r
  14 <a href="developer.html">Developer Documentation</a>\r
  15                         </div>\r
  16                 </div>\r
  17                 <div class="pageinformation">\r
  18                         <span class="pagetitle">1.25 xestiascan_users_add</span>\r
  19 <br><br>\r
  20 xestiascan_users_add adds a user to the user list or prints out a form for adding a user if the action to add an user has not been confirmed.\r
  21 <br><br>\r
  22 <b>Parameters:</b>\r
  23 <br><br>\r
  24 <div class="code">\r
  25 xestiascan_users_add(username, userinfo, scannerinfo, outputmoduleinfo, exportmoduleinfo, confirm);\r
  26 </div>\r
  27 <br><br>\r
  28 <b>Usage:</b>\r
  29 <br><br>\r
  30 <div class="code">\r
  31 $pagedata = xestiascan_users_add();<br>\r
  32 $pagedata = xestiascan_users_add(“New User”, \%userinfo, \%scannerinfo, \%outputmoduleinfo, \%exportmoduleinfo, 1);\r
  33 </div>\r
  34 <br><br>\r
  35 <i>username</i><br>\r
  36 Specifies the username to add to the user list.\r
  37 <br><br>\r
  38 <i>userinfo</i><br>\r
  39 Specifies the user information as a hashref.\r
  40 <br><br>\r
  41 <table class="infotable">\r
  42  <tr>\r
  43    <td class="tableheading">Setting</td>\r
  44    <td class="tableheading">Value</td>\r
  45  </tr>\r
  46  <tr>\r
  47    <td class="tabledata">Username</td>\r
  48    <td class="tabledata">Specifies the username.</td>\r
  49  </tr>\r
  50  <tr>\r
  51    <td class="tabledata">Name</td>\r
  52    <td class="tabledata">Specifies the name of the user.</td>\r
  53  </tr>\r
  54  <tr>\r
  55    <td class="tabledata">Password</td>\r
  56    <td class="tabledata">Specifies the password of the user.</td>\r
  57  </tr>\r
  58  <tr>\r
  59    <td class="tabledata">ConfirmPassword</td>\r
  60    <td class="tabledata">Specifies the confirmed password (should be same as Password).</td>\r
  61  </tr>\r
  62  <tr>\r
  63    <td class="tabledata">Admin</td>\r
  64    <td class="tabledata">Specifies if the user has administrative privledges.</td>\r
  65  </tr>\r
  66  <tr>\r
  67    <td class="tabledata">Enabled</td>\r
  68    <td class="tabledata">Specifies if the account is enabled.</td>\r
  69  </tr>\r
  70 </table>\r
  71 <br><br>\r
  72 <i>scannerinfo</i><br>\r
  73 Specifies the scanner permissions as a hashref.\r
  74 <br><br>\r
  75 <table class="infotable">\r
  76  <tr>\r
  77    <td class="tableheading">Setting</td>\r
  78    <td class="tableheading">Value</td>\r
  79  </tr>\r
  80  <tr>\r
  81    <td class="tabledata">scanner_(ScannerID)</td>\r
  82    <td class="tabledata">Specifies if the user has permission to use this scanner (A value of ‘on’ would allow the user to use that scanner).</td>\r
  83  </tr>\r
  84 </table>\r
  85 <br><br>\r
  86 <i>outputmoduleinfo</i><br>\r
  87 Specifies the output module permissions as a hashref. Each setting uses outputmodule_(OutputModuleName) and this specifies if the user has permission to use this output module (A value of ‘on’ would allow the user to use the module).\r
  88 <br><br>\r
  89 <i>exportmoduleinfo</i><br>\r
  90 Specifies the export module permissions as a hashref. Each settings uses exportmodule_(ExportModuleName) and this specifies if the user has permission to use this export module (A value of ‘on’ would allow the user to use the module).\r
  91 <br><br>\r
  92 <i>confirm</i><br>\r
  93 Confirms the action to add the user.\f\r
  94                 </div>\r
  95         </body>\r
  96 </html>\r