228 lines
No EOL
11 KiB
HTML
228 lines
No EOL
11 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
|
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|
|
|
<title>Using the Administrator Interface — Documentation</title>
|
|
<link rel="stylesheet" href="_static/sphinxdoc.css" type="text/css" />
|
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
|
<script type="text/javascript">
|
|
var DOCUMENTATION_OPTIONS = {
|
|
URL_ROOT: '',
|
|
VERSION: '',
|
|
COLLAPSE_MODINDEX: false,
|
|
FILE_SUFFIX: '.html',
|
|
HAS_SOURCE: true
|
|
};
|
|
</script>
|
|
<script type="text/javascript" src="_static/jquery.js"></script>
|
|
<script type="text/javascript" src="_static/doctools.js"></script>
|
|
<link rel="top" title="Documentation" href="index.html" />
|
|
<link rel="up" title="2. Building an Application" href="build_app.html" />
|
|
<link rel="next" title="Creating A Form (DocType)" href="creating_doctypes.html" />
|
|
<link rel="prev" title="2. Building an Application" href="build_app.html" />
|
|
</head>
|
|
<body>
|
|
<div style="background-color: #FFF; text-align: left; padding: 8px 0px"><img src="_static/banner300910.gif"></div>
|
|
<div class="related">
|
|
<h3>Navigation</h3>
|
|
<ul>
|
|
<li class="right" style="margin-right: 10px">
|
|
<a href="genindex.html" title="General Index"
|
|
accesskey="I">index</a></li>
|
|
<li class="right" >
|
|
<a href="modindex.html" title="Global Module Index"
|
|
accesskey="M">modules</a> |</li>
|
|
<li class="right" >
|
|
<a href="creating_doctypes.html" title="Creating A Form (DocType)"
|
|
accesskey="N">next</a> |</li>
|
|
<li class="right" >
|
|
<a href="build_app.html" title="2. Building an Application"
|
|
accesskey="P">previous</a> |</li>
|
|
<li><a href="index.html">Documentation</a> »</li>
|
|
<li><a href="build_app.html" accesskey="U">2. Building an Application</a> »</li>
|
|
</ul>
|
|
</div>
|
|
<div class="sphinxsidebar">
|
|
<div class="sphinxsidebarwrapper">
|
|
<h3><a href="index.html">Table Of Contents</a></h3>
|
|
<ul>
|
|
<li><a class="reference external" href="">Using the Administrator Interface</a><ul>
|
|
<li><a class="reference external" href="#what-is-an-application">What is an Application?</a></li>
|
|
<li><a class="reference external" href="#administrator-login">Administrator Login</a></li>
|
|
<li><a class="reference external" href="#creating-entities">Creating Entities</a></li>
|
|
<li><a class="reference external" href="#managing-roles">Managing Roles</a></li>
|
|
<li><a class="reference external" href="#creating-users-profile">Creating Users (Profile)</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
|
|
<h4>Previous topic</h4>
|
|
<p class="topless"><a href="build_app.html"
|
|
title="previous chapter">2. Building an Application</a></p>
|
|
<h4>Next topic</h4>
|
|
<p class="topless"><a href="creating_doctypes.html"
|
|
title="next chapter">Creating A Form (DocType)</a></p>
|
|
<h3>This Page</h3>
|
|
<ul class="this-page-menu">
|
|
<li><a href="_sources/apps_intro.txt"
|
|
rel="nofollow">Show Source</a></li>
|
|
</ul>
|
|
<div id="searchbox" style="display: none">
|
|
<h3>Quick search</h3>
|
|
<form class="search" action="search.html" method="get">
|
|
<input type="text" name="q" size="18" />
|
|
<input type="submit" value="Go" />
|
|
<input type="hidden" name="check_keywords" value="yes" />
|
|
<input type="hidden" name="area" value="default" />
|
|
</form>
|
|
<p class="searchtip" style="font-size: 90%">
|
|
Enter search terms or a module, class or function name.
|
|
</p>
|
|
</div>
|
|
<script type="text/javascript">$('#searchbox').show(0);</script>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="document">
|
|
<div class="documentwrapper">
|
|
<div class="bodywrapper">
|
|
<div class="body">
|
|
|
|
<div class="section" id="using-the-administrator-interface">
|
|
<h1>Using the Administrator Interface<a class="headerlink" href="#using-the-administrator-interface" title="Permalink to this headline">¶</a></h1>
|
|
<p>Applications are built using the web based administrator interface of the framework.</p>
|
|
<p>Let us start discuss how to build applications using the basic building blocks</p>
|
|
<div class="section" id="what-is-an-application">
|
|
<h2>What is an Application?<a class="headerlink" href="#what-is-an-application" title="Permalink to this headline">¶</a></h2>
|
|
<p>Let us define a typical web application as being a set of:</p>
|
|
<blockquote>
|
|
<ol class="arabic simple">
|
|
<li>Users - who use the application</li>
|
|
<li>Roles - roles assigned to users for various functions</li>
|
|
<li>Pages - where users navigate and see relevant information</li>
|
|
<li>Forms - where users enter new data</li>
|
|
<li>Reports - where users get a tabulated view of their data</li>
|
|
<li>Permission Rules - that define what each role is allowed to do or not do</li>
|
|
<li>Logic - Automatic actions that are performed at various events</li>
|
|
<li>Validations - Checks that ensure the data entered by the users is valid</li>
|
|
<li>Print Formats - Printable documents based on the data users have entered</li>
|
|
<li>UI Widgets - Menus, Lists, Dialogs that are used for navigating, entering or displaying information</li>
|
|
<li>Module - So that you can group Roles, Forms, Pages, Reports for more complex applications</li>
|
|
</ol>
|
|
</blockquote>
|
|
<p>Let us now start building these entities in the wnframework</p>
|
|
</div>
|
|
<div class="section" id="administrator-login">
|
|
<h2>Administrator Login<a class="headerlink" href="#administrator-login" title="Permalink to this headline">¶</a></h2>
|
|
<p>An application is built via the browser front end. To have the right access to build applications, you must
|
|
login as an Administrator.</p>
|
|
<p>If you are in a new system that does not have any application, your first login as “Administrator” is the
|
|
Administrator login.</p>
|
|
</div>
|
|
<div class="section" id="creating-entities">
|
|
<h2>Creating Entities<a class="headerlink" href="#creating-entities" title="Permalink to this headline">¶</a></h2>
|
|
<p>To create any entity, you must have the relevant permission. Once you have the relevant permission, you can
|
|
create new entities from the top toolbar.</p>
|
|
<p>Look out for the “New” button on the top left of the page. Via the “New” dialog box, you can create any
|
|
entity you have rights to create.</p>
|
|
<div class="admonition note">
|
|
<p class="first admonition-title">Note</p>
|
|
<ul class="last simple">
|
|
<li>Entities in wnframework are known by their “name”. Name has the same concept as id - its a unique key
|
|
for that entity (same as a Primary Key).</li>
|
|
<li>Every entity also has an “owner” - By default this is the user who creates that entity.</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="managing-roles">
|
|
<h2>Managing Roles<a class="headerlink" href="#managing-roles" title="Permalink to this headline">¶</a></h2>
|
|
<p>Roles are assigned to users so that you can define a group of users and set permission (or other) rules.</p>
|
|
<blockquote>
|
|
<ol class="arabic simple">
|
|
<li>To create a new role, click “New” on the top toolbar and select “Role”</li>
|
|
<li>Give the Role name, use descriptive names here like - “Contact Manager”</li>
|
|
<li>Set the module, (use the standard; if you want create a new module, go ahead!)</li>
|
|
<li>Click on the green “Save” button</li>
|
|
</ol>
|
|
</blockquote>
|
|
<p>Your new Roles is created! To check, click on the “Search” button on the top toolbar and select “Role”
|
|
Click on “Search” and see that your new Role is added to the list of already existing roles:</p>
|
|
<div class="admonition note">
|
|
<p class="first admonition-title">Note</p>
|
|
<p>Pre-defined roles. There are 3 basic roles that are pre-defined in the system. It is suggested,
|
|
you leave them as it is!</p>
|
|
<blockquote class="last">
|
|
<ol class="arabic simple">
|
|
<li>Administrator: Role given to the application builder / maintainer</li>
|
|
<li>All: All logged in users have the role “All”</li>
|
|
<li>Guest: Users who are not yet logged in.</li>
|
|
</ol>
|
|
</blockquote>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="creating-users-profile">
|
|
<h2>Creating Users (Profile)<a class="headerlink" href="#creating-users-profile" title="Permalink to this headline">¶</a></h2>
|
|
<p>A Profile (=user) has a unique identity in the system and can be tagged as an “onwer” to a data record.
|
|
Profiles can also be assigned Roles that restrict what they can do. You can also define custom logic
|
|
for a Profile</p>
|
|
<p>To create a new Profile:</p>
|
|
<blockquote>
|
|
<ol class="arabic simple">
|
|
<li>Create a new Profile via “New” on the top toolbar</li>
|
|
<li>Enter the mandatory “First Name” and “Email” values</li>
|
|
<li>“Save” the profile via the “Save” button</li>
|
|
<li>The user will be sent an email with her random-genereated password. You can also set a custom password
|
|
by clicking on the “Password” tab and setting the password.</li>
|
|
<li><em>To assign a role, click on the “Roles” tab and add a “Role” in the table.</em></li>
|
|
</ol>
|
|
</blockquote>
|
|
<p>Once a Profile is created, the user can login with the login id (email) and password.</p>
|
|
<div class="admonition note">
|
|
<p class="first admonition-title">Note</p>
|
|
<p>Profiles are given an id that is the same as their email id. Why did we do this?</p>
|
|
<blockquote class="last">
|
|
<ul class="simple">
|
|
<li>Email Ids are good unique identifiers. Your users may have the same first and last names,
|
|
but they would have separate Email Ids</li>
|
|
<li>People usually remember their email ids</li>
|
|
<li>Email Ids are these days the de-facto way to define login-ids</li>
|
|
</ul>
|
|
</blockquote>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="clearer"></div>
|
|
</div>
|
|
<div class="related">
|
|
<h3>Navigation</h3>
|
|
<ul>
|
|
<li class="right" style="margin-right: 10px">
|
|
<a href="genindex.html" title="General Index"
|
|
>index</a></li>
|
|
<li class="right" >
|
|
<a href="modindex.html" title="Global Module Index"
|
|
>modules</a> |</li>
|
|
<li class="right" >
|
|
<a href="creating_doctypes.html" title="Creating A Form (DocType)"
|
|
>next</a> |</li>
|
|
<li class="right" >
|
|
<a href="build_app.html" title="2. Building an Application"
|
|
>previous</a> |</li>
|
|
<li><a href="index.html">Documentation</a> »</li>
|
|
<li><a href="build_app.html" >2. Building an Application</a> »</li>
|
|
</ul>
|
|
</div>
|
|
<div class="footer">
|
|
© Copyright 2010, Rushabh Mehta.
|
|
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.3.
|
|
</div>
|
|
</body>
|
|
</html> |