選択できるのは25トピックまでです。 トピックは、先頭が英数字で、英数字とダッシュ('-')を使用した35文字以内のものにしてください。
 
 
 
 
 
 

228 行
11 KiB

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  2. "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  3. <html xmlns="http://www.w3.org/1999/xhtml">
  4. <head>
  5. <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  6. <title>Using the Administrator Interface &mdash; Documentation</title>
  7. <link rel="stylesheet" href="_static/sphinxdoc.css" type="text/css" />
  8. <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
  9. <script type="text/javascript">
  10. var DOCUMENTATION_OPTIONS = {
  11. URL_ROOT: '',
  12. VERSION: '',
  13. COLLAPSE_MODINDEX: false,
  14. FILE_SUFFIX: '.html',
  15. HAS_SOURCE: true
  16. };
  17. </script>
  18. <script type="text/javascript" src="_static/jquery.js"></script>
  19. <script type="text/javascript" src="_static/doctools.js"></script>
  20. <link rel="top" title="Documentation" href="index.html" />
  21. <link rel="up" title="2. Building an Application" href="build_app.html" />
  22. <link rel="next" title="Creating A Form (DocType)" href="creating_doctypes.html" />
  23. <link rel="prev" title="2. Building an Application" href="build_app.html" />
  24. </head>
  25. <body>
  26. <div style="background-color: #FFF; text-align: left; padding: 8px 0px"><img src="_static/banner300910.gif"></div>
  27. <div class="related">
  28. <h3>Navigation</h3>
  29. <ul>
  30. <li class="right" style="margin-right: 10px">
  31. <a href="genindex.html" title="General Index"
  32. accesskey="I">index</a></li>
  33. <li class="right" >
  34. <a href="modindex.html" title="Global Module Index"
  35. accesskey="M">modules</a> |</li>
  36. <li class="right" >
  37. <a href="creating_doctypes.html" title="Creating A Form (DocType)"
  38. accesskey="N">next</a> |</li>
  39. <li class="right" >
  40. <a href="build_app.html" title="2. Building an Application"
  41. accesskey="P">previous</a> |</li>
  42. <li><a href="index.html">Documentation</a> &raquo;</li>
  43. <li><a href="build_app.html" accesskey="U">2. Building an Application</a> &raquo;</li>
  44. </ul>
  45. </div>
  46. <div class="sphinxsidebar">
  47. <div class="sphinxsidebarwrapper">
  48. <h3><a href="index.html">Table Of Contents</a></h3>
  49. <ul>
  50. <li><a class="reference external" href="">Using the Administrator Interface</a><ul>
  51. <li><a class="reference external" href="#what-is-an-application">What is an Application?</a></li>
  52. <li><a class="reference external" href="#administrator-login">Administrator Login</a></li>
  53. <li><a class="reference external" href="#creating-entities">Creating Entities</a></li>
  54. <li><a class="reference external" href="#managing-roles">Managing Roles</a></li>
  55. <li><a class="reference external" href="#creating-users-profile">Creating Users (Profile)</a></li>
  56. </ul>
  57. </li>
  58. </ul>
  59. <h4>Previous topic</h4>
  60. <p class="topless"><a href="build_app.html"
  61. title="previous chapter">2. Building an Application</a></p>
  62. <h4>Next topic</h4>
  63. <p class="topless"><a href="creating_doctypes.html"
  64. title="next chapter">Creating A Form (DocType)</a></p>
  65. <h3>This Page</h3>
  66. <ul class="this-page-menu">
  67. <li><a href="_sources/apps_intro.txt"
  68. rel="nofollow">Show Source</a></li>
  69. </ul>
  70. <div id="searchbox" style="display: none">
  71. <h3>Quick search</h3>
  72. <form class="search" action="search.html" method="get">
  73. <input type="text" name="q" size="18" />
  74. <input type="submit" value="Go" />
  75. <input type="hidden" name="check_keywords" value="yes" />
  76. <input type="hidden" name="area" value="default" />
  77. </form>
  78. <p class="searchtip" style="font-size: 90%">
  79. Enter search terms or a module, class or function name.
  80. </p>
  81. </div>
  82. <script type="text/javascript">$('#searchbox').show(0);</script>
  83. </div>
  84. </div>
  85. <div class="document">
  86. <div class="documentwrapper">
  87. <div class="bodywrapper">
  88. <div class="body">
  89. <div class="section" id="using-the-administrator-interface">
  90. <h1>Using the Administrator Interface<a class="headerlink" href="#using-the-administrator-interface" title="Permalink to this headline">¶</a></h1>
  91. <p>Applications are built using the web based administrator interface of the framework.</p>
  92. <p>Let us start discuss how to build applications using the basic building blocks</p>
  93. <div class="section" id="what-is-an-application">
  94. <h2>What is an Application?<a class="headerlink" href="#what-is-an-application" title="Permalink to this headline">¶</a></h2>
  95. <p>Let us define a typical web application as being a set of:</p>
  96. <blockquote>
  97. <ol class="arabic simple">
  98. <li>Users - who use the application</li>
  99. <li>Roles - roles assigned to users for various functions</li>
  100. <li>Pages - where users navigate and see relevant information</li>
  101. <li>Forms - where users enter new data</li>
  102. <li>Reports - where users get a tabulated view of their data</li>
  103. <li>Permission Rules - that define what each role is allowed to do or not do</li>
  104. <li>Logic - Automatic actions that are performed at various events</li>
  105. <li>Validations - Checks that ensure the data entered by the users is valid</li>
  106. <li>Print Formats - Printable documents based on the data users have entered</li>
  107. <li>UI Widgets - Menus, Lists, Dialogs that are used for navigating, entering or displaying information</li>
  108. <li>Module - So that you can group Roles, Forms, Pages, Reports for more complex applications</li>
  109. </ol>
  110. </blockquote>
  111. <p>Let us now start building these entities in the wnframework</p>
  112. </div>
  113. <div class="section" id="administrator-login">
  114. <h2>Administrator Login<a class="headerlink" href="#administrator-login" title="Permalink to this headline">¶</a></h2>
  115. <p>An application is built via the browser front end. To have the right access to build applications, you must
  116. login as an Administrator.</p>
  117. <p>If you are in a new system that does not have any application, your first login as &#8220;Administrator&#8221; is the
  118. Administrator login.</p>
  119. </div>
  120. <div class="section" id="creating-entities">
  121. <h2>Creating Entities<a class="headerlink" href="#creating-entities" title="Permalink to this headline">¶</a></h2>
  122. <p>To create any entity, you must have the relevant permission. Once you have the relevant permission, you can
  123. create new entities from the top toolbar.</p>
  124. <p>Look out for the &#8220;New&#8221; button on the top left of the page. Via the &#8220;New&#8221; dialog box, you can create any
  125. entity you have rights to create.</p>
  126. <div class="admonition note">
  127. <p class="first admonition-title">Note</p>
  128. <ul class="last simple">
  129. <li>Entities in wnframework are known by their &#8220;name&#8221;. Name has the same concept as id - its a unique key
  130. for that entity (same as a Primary Key).</li>
  131. <li>Every entity also has an &#8220;owner&#8221; - By default this is the user who creates that entity.</li>
  132. </ul>
  133. </div>
  134. </div>
  135. <div class="section" id="managing-roles">
  136. <h2>Managing Roles<a class="headerlink" href="#managing-roles" title="Permalink to this headline">¶</a></h2>
  137. <p>Roles are assigned to users so that you can define a group of users and set permission (or other) rules.</p>
  138. <blockquote>
  139. <ol class="arabic simple">
  140. <li>To create a new role, click &#8220;New&#8221; on the top toolbar and select &#8220;Role&#8221;</li>
  141. <li>Give the Role name, use descriptive names here like - &#8220;Contact Manager&#8221;</li>
  142. <li>Set the module, (use the standard; if you want create a new module, go ahead!)</li>
  143. <li>Click on the green &#8220;Save&#8221; button</li>
  144. </ol>
  145. </blockquote>
  146. <p>Your new Roles is created! To check, click on the &#8220;Search&#8221; button on the top toolbar and select &#8220;Role&#8221;
  147. Click on &#8220;Search&#8221; and see that your new Role is added to the list of already existing roles:</p>
  148. <div class="admonition note">
  149. <p class="first admonition-title">Note</p>
  150. <p>Pre-defined roles. There are 3 basic roles that are pre-defined in the system. It is suggested,
  151. you leave them as it is!</p>
  152. <blockquote class="last">
  153. <ol class="arabic simple">
  154. <li>Administrator: Role given to the application builder / maintainer</li>
  155. <li>All: All logged in users have the role &#8220;All&#8221;</li>
  156. <li>Guest: Users who are not yet logged in.</li>
  157. </ol>
  158. </blockquote>
  159. </div>
  160. </div>
  161. <div class="section" id="creating-users-profile">
  162. <h2>Creating Users (Profile)<a class="headerlink" href="#creating-users-profile" title="Permalink to this headline">¶</a></h2>
  163. <p>A Profile (=user) has a unique identity in the system and can be tagged as an &#8220;onwer&#8221; to a data record.
  164. Profiles can also be assigned Roles that restrict what they can do. You can also define custom logic
  165. for a Profile</p>
  166. <p>To create a new Profile:</p>
  167. <blockquote>
  168. <ol class="arabic simple">
  169. <li>Create a new Profile via &#8220;New&#8221; on the top toolbar</li>
  170. <li>Enter the mandatory &#8220;First Name&#8221; and &#8220;Email&#8221; values</li>
  171. <li>&#8220;Save&#8221; the profile via the &#8220;Save&#8221; button</li>
  172. <li>The user will be sent an email with her random-genereated password. You can also set a custom password
  173. by clicking on the &#8220;Password&#8221; tab and setting the password.</li>
  174. <li><em>To assign a role, click on the &#8220;Roles&#8221; tab and add a &#8220;Role&#8221; in the table.</em></li>
  175. </ol>
  176. </blockquote>
  177. <p>Once a Profile is created, the user can login with the login id (email) and password.</p>
  178. <div class="admonition note">
  179. <p class="first admonition-title">Note</p>
  180. <p>Profiles are given an id that is the same as their email id. Why did we do this?</p>
  181. <blockquote class="last">
  182. <ul class="simple">
  183. <li>Email Ids are good unique identifiers. Your users may have the same first and last names,
  184. but they would have separate Email Ids</li>
  185. <li>People usually remember their email ids</li>
  186. <li>Email Ids are these days the de-facto way to define login-ids</li>
  187. </ul>
  188. </blockquote>
  189. </div>
  190. </div>
  191. </div>
  192. </div>
  193. </div>
  194. </div>
  195. <div class="clearer"></div>
  196. </div>
  197. <div class="related">
  198. <h3>Navigation</h3>
  199. <ul>
  200. <li class="right" style="margin-right: 10px">
  201. <a href="genindex.html" title="General Index"
  202. >index</a></li>
  203. <li class="right" >
  204. <a href="modindex.html" title="Global Module Index"
  205. >modules</a> |</li>
  206. <li class="right" >
  207. <a href="creating_doctypes.html" title="Creating A Form (DocType)"
  208. >next</a> |</li>
  209. <li class="right" >
  210. <a href="build_app.html" title="2. Building an Application"
  211. >previous</a> |</li>
  212. <li><a href="index.html">Documentation</a> &raquo;</li>
  213. <li><a href="build_app.html" >2. Building an Application</a> &raquo;</li>
  214. </ul>
  215. </div>
  216. <div class="footer">
  217. &copy; Copyright 2010, Rushabh Mehta.
  218. Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.3.
  219. </div>
  220. </body>
  221. </html>