Protohistory/ctasapagar
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
170557d88c
ctasapagar/helptopics.html
JesusPerez 170557d88c chore: html pages
2021-10-01 20:28:38 +01:00

433 lines
24 KiB
HTML
Raw Blame History

<HTML>
<HEAD>
<META NAME="GENERATOR" CONTENT="Adobe PageMill 2.0 Win">
<TITLE>Tock Help</TITLE>
</HEAD>
<BODY BGCOLOR="#ffffff">
<P><IMG SRC="images/help.gif" ALT="Help" WIDTH="122" HEIGHT="59" NATURALSIZEFLAG=
"0" ALIGN="BOTTOM"> <BACKGROUND="images/backgrnd.gif"> <HR ALIGN=LEFT><A
NAME="intro"></A></P>
<H2>Introducci&oacute;n. &iquest;Que es?, &iquest;Que hace?.</H2>
<!--
<P><A NAME="creators"></A></P>
<H3>About the Creators of Tock</H3>
<P><A HREF="http://www.imservice.com/">Internet Media Services (IMS)</A>
designs and builds database applications for the Internet and corporate
Intranet. The Tock time tracking system demonstrates IMS's commitment to
creating robust web applications with intuitive, easy to use interfaces.</P>
<P><B>If you would like IMS to customize Tock for your organization or consult
with you to create other Internet/Intranet applications, please contact
at <A HREF="http://www.imservice.com/tock/forms/request.html">sales@imservice.com
</A>or (415) 617-0701. </B></P>
<P><A HREF="http://www.imservice.com/clients/initial.html">Other IMS web-based
solutions</A> include an employee directory / &quot;expert&quot; locator,
project management system, computer-based training, operations monitoring,
data collection, newsfeed displays, and research and reporting applications.
<A NAME="application"></A></P>
<H3>About the Application</H3>
<P>Tock is an application for logging time spent on projects, and generating
reports which can be used for payroll, billing, and project management.
This is an essential application for anyone whose business relies on managing
and reporting time spent on projects. <HR ALIGN=LEFT><A NAME="techsup"></A></P>
<H2>Tecnolog&iacute;a y plataforma.</H2>
<P>Tock is distributed free of charge as an unsupported application. However,
IMS provides a Frequently Asked Questions (FAQ) forum for Tock users, and
welcomes your comments and suggestions.</P>
<UL>
<P>For HELP using Tock, check out the <A HREF="http://www.imservice.com/tock/faq/initial.html">Tock
FAQ</A> on the <A HREF="http://www.imservice.com/">IMS</A> web site.
<P>To REPORT BUGS or other critical issues, SUGGEST feature changes/additions,
or just send your COMMENTS, send email to <A HREF="http://www.imservice.com/tock/forms/comments.html">tock@imservice.com
</A>
<P>If you would like <A HREF="http://www.imservice.com/">IMS</A> to install
a CUSTOMIZED VERSION of Tock or to discuss the development of other Intranet/Internet
applications, send email to <A HREF="http://www.imservice.com/tock/forms/request.html">sales@imservice.com
</A>or call (415) 617-0701.
</UL>
//-->
</SCRIPT>
<P><HR ALIGN=LEFT><A NAME="userguide"></A></P>
<H2>Esquema y estructura de datos. Como Usar esta Aplicaci&oacute;n:</H2>
<P><A NAME="entry"></A></P>
<H3>Como usar cursor, rat&oacute;n y navegador.</H3>
<P>En primer lugar significar que con el rat&oacute;n funciona todo solamente
apuntando al campo o a la opci&oacute;n a utilizar.</P>
<P>Para avanzar el cursor de un campo a otro solo se puede hacer con el
tabulador, para retroceder al anterior shitf + tabulador, una vez terminados
de rellenar los campos necesarios se desplaza el cursor con el tabulador
o con el rat&oacute;n directamente hacia la opci&oacute;n que necesite (busqueda,
confirmar, ver, alta, etc..) y se pulsa la barra espaciadora(*).</P>
<P>Para enfocar de un frame(*) a otro solo se puede hacer con el rat&oacute;n,
por ejemplo:</P>
<P> En la pantalla de facturas, &eacute;sta aparece a su derecha (1 frame),
y el menu principal a su izquierda (2&ordm; frame, mas peque&ntilde;o),
si quiere trabajar en facturas debe de apuntar a ese frame con el rat&oacute;n
para que el cursor se sit&uacute;e al principio y la misma operaci&oacute;n
debe realizar si quiere paar al frame peque&ntilde;o, del men&uacute; principal
en este caso.</P>
<P>* La barra espaciadora en este caso hace la misma funci&oacute;n que
INTRO.</P>
<P>* Se puede definir Frame como una pantalla dentro de otra que puede ser
de diversos tama&ntilde;os.</P>
<H4>Navegador Netscape Gold 3.0.</H4>
<P>Algunos conceptos b&aacute;sicos para el uso del navegador:</P>
<P>&nbsp;</P>
<P>&nbsp;</P>
<H3>Running Reports</H3>
<P><B>Step One: Enter the Date</B></P>
<P>The first step for all reports is to select a date range. If you do not
select a date range your report will default to the last 7 days (including
today).</P>
<P>To select a date range click on the radio button associated with either
a set amount of time (last 7 days, last 14 days or month to date) or input
your own date range in mm/dd/yy format.</P>
<P>Last 7 days, 14 days and month to date all include date from today.</P>
<P>&nbsp;</P>
<P><B>Step Two: Choose either a summary or detail report</B></P>
<P>To run a <B>summary report</B> select how you want the report broken
down from the pop up menu and click on the Create Summary Report button.</P>
<P>&nbsp;</P>
<UL>
<LI>A summary report by employee lists the total hours entered for each
employee during the date range you selected. <BR>
<LI>A summary report by project lists the total hours entered for each
project during the date range you selected. <BR>
<LI>A summary report by group lists the total hours entered for each group
during the date range you selected. <BR>
<LI>A summary report by category lists the total hours entered for each
category during the date range you selected.
<P>To run a<B> detail report</B> you first choose one of the four categories:
Employee, Group, Project or Type of Work by clicking on the corresponding
radio button. Then use the select list to choose the item for which you
would like generate a report. Click Create Detail Report to produce the
report.
<P>&nbsp;
<P><A NAME="edit_report"></A><B>Editing Your Entries</B>
<P>You can edit your hours entries from the report section. Select your
name in the employee list under Detail Report. Select all entries in the
select list. Click CREATE DETAIL REPORT to run the report. Click a field
of the entry you want to edit. Change whatever details you want, then click
Update to save your changes.
<P><HR ALIGN=LEFT><A NAME="prefs"></A><H3>Preferences and User Information</H3>
<P><B>Entering your information</B>
<P><B>Password:</B> Your user name and a temporary password will be added
to the system by your administrator. You may go in at any time to change
your password by clicking on Change Password link. You will need to know
your current password to change your password.
<P>You can update most of your information by changing the text or selection
lists on the preferences page and then clicking the SAVE CHANGES button.
<P>Only your administrator can change your active status, full/part time
status, and group.
<P><B>User Preferences</B>
<P><B>Active Projects:</B> The projects you select here will show up on
your hours entry page. You may select as many as you like (you may need
to hold down the control or apple key to make multiple selections). If
a project you will be working on is not listed, contact your administrator.
<P><B>Default Project:</B> Select the project that you work on the most
often from the pop up menu (it must be one of your active projects). Your
enter hours page will default to this project if no other project is selected.
<P><B>Default Type of Work:</B> Select the type of work that you do the
most often from the pop up menu. Your enter hours page will default to
this type of work if no other type of work is selected.
<P>After making any changes click on SAVE CHANGES and your information
will be updated to the database.
<P><HR ALIGN=LEFT><A NAME="admin"></A><H3>Administration</H3>
<P><B>Add User:</B> Enter the user's information and click on Add User.
Required information is: first name, last name, user name, temporary password,
group, and project information. You can update this information at any
time. Only administrators can edit the active status, full/part time status,
and group fields. The user's login, password, first name, last name, title,
email, and phone can not contain double quotes. The user's email and phone
can not contain single quotes.
<P><B>Add Group:</B> Type in the group name. Choose group members from
the select list. You may select as many as you wish (you may need to hold
down the control or apple key to make multiple selections). Remember, a
user can only be a member of one group at a time. Click on Add Group. The
group name can not contain single or double quotes.
<P><B>Add Project:</B> Type in the project name. Choose Active or Inactive,
and Billable or Non Billable from the select lists. Click on Add Project.
The project name can not contain single or double quotes.
<P><B>Add Type of Work:</B> Type in the name of the new type of work. Click
on Add Type of Work. The name of the type of work can not contain single
or double quotes.
<P><B>Edit User:</B> Choose a user from the select list that you would
like to edit and click on USER. Follow the same directions for Add User
to edit user information. Click SAVE CHANGES to update the user information.
To delete a user click on Delete User. You may only delete a user if they
have never entered any hours. If you want to prevent a user from logging
in, make the user inactive. The user's login, password, first name, last
name, title, email, and phone can not contain double quotes. The user's
email and phone can not contain single quotes.
<P><B>Reset Password:</B> If a user has forgotten his or her password,
select the user from the list and click USER. From the user information
screen, click on Reset Password. This will reset the user's password to
his or her user id.
<P><B>Edit Group:</B> To edit the group name only, change the name and
then click on UPDATE THIS GROUP. You can also move users into and out of
the group you are editing. A user can only be in one group at a time. If
you remove a user from a group they will be put into the special group
called No Group. If you add a user to a group you will automatically take
him or her out of the group he or she is in currently.
<P><B>Group Members, Group Name:</B> If you choose a name from this select
list and click on UPDATE THIS GROUP this person will be removed from the
group and added to No Group. The group name can not contain single or double
quotes.
<P><B>All Other Employees:</B> If you choose a name from this select list
and click on UPDATE THIS GROUP this person will be added to the group which
you are editing and deleted from whatever group s/he was in previously.
<P><B>Deleting a Group:</B> You may only delete a group if it has no members.
Once you remove all of the members, click on DELETE THIS GROUP.
<P><B>Edit a Project:</B> You may a edit the project name by changing the
text and clicking on UPDATE PROJECT. You may also change the status of
a project: Inactive or Active and Billable or Non Billable; by selecting
the correct status from the select lists and then clicking on UPDATE PROJECTS.
A project cannot be deleted if hours have been entered for it. If you no
longer need a project, make it project inactive. The project name can not
contain single or double quotes.
<P><B>Edit Type of Work:</B> You may change the type of work by changing
the text and then clicking on UPDATE TYPE OF WORK. You may not delete a
category if hours have been entered using that type of work.
<P>The name of the type of work can not contain single or double quotes.
<HR ALIGN=LEFT><A NAME="troubleshooting"></A><H2>Troubleshooting and Known
Problems</H2>
<P><h4>Navigator 2.0</h4> This application is <B>not</B> recommended for
use with Navigator 2.0.x. Several problems in 2.0 versions of Navigator
prevent some areas of the application from working properly. These include
(but may not be limited to):
<UL>
<LI>Radio buttons are ordered differently for JavaScript in Navigator 2.0.x
and 3.0. On the reports screen the radio buttons will not be selected properly
using Navigator 2.0.x. On Navigator 2.0.x for the Macintosh, it's possible
to have more than one radio button selected.
<LI>The help system does not work for Navigator 2.0.x Unix versions.
<LI>Java Script functions are sometimes not called correctly using Navigator
2.0.x. This problem has been reported on the login screen, on the hours
entry screen, and on the reports screen.
</UL>
<P>The Java applet on the hours entry screen uses Live Connect to update
itself based on user input. This functionality is only available with Netscape
3.0 browsers.
<P><h4>Admin privileges</h4> You can delete all users with admin privileges.
If you do this, you will not be able to create new users or change the
admin privileges of users to get admin privileges back. We recommend that
you do not ever delete the admin user created during the install (username
admin, password admin) in case you accidentally remove admin privileges
from all other uses.
<P><h4>Alphabetical Order</h4> Every list of projects, types of work, users,
etc. is alphabetized. However, the lists are alphabetized using ASCII collating
sequence, which means that lowercase letters come after uppercase letters.
If your projects, types of work, etc. start with both upper and lowercase
letters, the entries will not seem to be ordered. We recommend that you
start all items with either uppercase or lowercase letters, not both.
<P><h4>Logging out and the back button</h4> After you log out of the system,
you can still see screens using the back button. If you try to click on
anything on these screens, you will be asked to log in again. If you have
sensitive information on these screens, you may want to exit the browser
before leaving your machine.
<P><h4>Dates</h4> Java Script can not work with dates before 1970. If you
enter a two digit year less than 70 (for example, 8/5/15), the year will
be added to 2000 (for the previous example, the date will become 8/5/2015).
<P><h4>Entering hours</h4> Although the Java applet graph updates as you
enter hours, this information is not saved in the database until you click
Save. <h4>Deleting a project, group, or category</h4> A project or category
cannot be deleted if hours have been entered which reference it. You can
make a project inactive, which will prevent it from appearing in reports.
Groups can be only be deleted if they have no members. Put everyone in
the group you'd like to delete in different groups, then delete the group.
<h4>Screen not displaying properly</h4> Try resizing your browser or reloading
the page. <h4>I typed in a URL and it loaded the hours entry screen instead</h4>
You do not have the privileges to see the page you requested, or you attempted
to view a page which was not intended to be accessed directly. You should
be able to use every feature of the application from the button bar or
links within the pages. If you're interested in looking at the source code,
use an external viewer. <h4>I entered comments with my hours, but they're
not showing up in the report</h4> Comments are printed only for the show
all entries reports. For all other reports, each line may be representing
multiple entries.
<P><HR ALIGN=LEFT><A NAME="devguide"></A><H2>How This Application Works</H2>
<P><h3>General</h3> <h4>Project variables</h4> Tock uses project variables
to minimize the number of database lookups which must be performed. Because
the project variables are available to all users of the application, they
only need to be set once, and reset as needed. Tock stores lists of work
types, projects, groups, and employees. Pages which use these values call
load functions to set these variables if they have not been set already.
<P><h4>Access control</h4> The application uses LiveWire's client cookies
to maintain state. This means that until the user's cookies expire, she
or he will be recognized by the system and won't have to enter a user name
and password every time. A logout function erases these cookies so that
another person can use the same machine to access the application using
her own login. This is also useful to prevent access after leaving the
machine unattended.
<P>Tock also stores a number of useful data items using client cookies.
These cookies are used to store items such as the user's id, login name,
full name, default project, default category, list of active projects,
and the page the user came from.
<P>In addition to cookies, Tock uses a simple security scheme to verify
that the user has actually passed through the login screens. This consists
of setting a cookie whose name is determined at login time, and then checking
whether this cookie is set before displaying a page.
<P>Some pages in this application should never be accessed directly, such
as pages that perform database actions based on form input. In order to
access one of these pages, the prevPage cookie must be set to the correct
value. The only way to set this value correctly is to click submit on the
page which provides the form input for the page. This prevents users from
typing in URLs and seeing pages they shouldn't.
<P>On each page, the function checkPrevPage is called with the name of
the current page. This function
<UL>
<LI>checks whether there is a connection to the database
<LI>verifies that the user has logged in correctly
<LI>if a page has a prerequisite, checks that the user is coming from the
correct page using the prevPage cookie
</UL>
<P>If any of these checks fail, the user is redirected to the login screen.
If the user is logged in, s/he will go directly to the enter hours screen.
If all checks succeed, the prevPage cookie is set to the current page and
processing continues.
<P>A similar process is used to check a user's admin status before displaying
pages that only admins should be able to see. The function lookupAdminStatus
performs a database query to determine whether a user has admin privileges.
<P><h4>Input validation</h4> Tock uses Java Script extensively to validate
user input and provide immediate feedback. This prevents having to switch
back and forth between the form screen and an error screen, trying to determine
what went wrong. Java Script is used to ensure that dates are valid, date
ranges make sense, fields are not too long for the database, all necessary
selections have been made, and that database constraints are enforced.
<P><h4>Database interaction</h4> Tock uses Live Wire's database connectivity
in every aspect of its functionality. The data users enter on the hours
entry screen is saved to the database, where it is immediately available
for producing reports. The reports retrieve information from the database
and present it in a variety of views so that it is useful to the user.
User preference information is stored in the database and used to customize
the application on the fly for each user. The admin section provides an
easy to use way to administer the Tock database.
<P><h3>Hours Entry</h3> The hours entry screen uses a form to collect information
about the date, project, category, and number of hours a user has worked,
and stores this information in the database.
<P>The hours entry screen contains a Java applet which graphs a user's
hours based on entries in the database. It also takes advantage of Live
Connect to update the graph every time the user enters hours on the form.
The date field, hours, and hours fraction fields all have onChange event
handlers which determine if the graph should be updated, and if so, call
a Java method to instantly change the graph.
<P>The date field uses a Java Script function to ensure that the user has
entered a valid date. A warning pops up if the date is not valid.
<P>The list of projects each user sees is determined at page generation
time from the user's list of active projects in the database. This list
can be changed at any time using the preferences screen. Any projects which
are made inactive will not appear in the list.
<P>If a user attempts to enter more than 24 hours for a single day this
week, a warning pops up and the hours for the entry are reset. For hours
outside this week, the user cannot enter more than 24 hours on the form.
As the hours entries are inserted into the database, each entry is checked
to see whether it puts the user over 24 hours for a day. If so, the hours
for that are set to 0, all other information is retained, and the user
is warned and asked to edit the entries for that day.
<P>Comments have a maximum length of 250 characters. If the user types
a comment longer than this, the user has the option of truncating the comment
or editing it to be under 250 characters.
<P><h3>Reports</h3> The reports screen is a form which allows the user
to define a view of the hours data. The form input is used to construct
database queries. The results of these queries are formatted using Java
Script functions. This methodology should be easily extensible should a
developer which to add new types of reports, since s/he would need only
to construct a new query and could use the existing functions to format
and display the report.
<P>The reports screen uses Java Script to ensure that the date range entered
by the user is valid and that the user has selected an item from the select
list for they type of report s/he wants to generate. The radio button next
to each select list is checked automatically using the onChange event handler
when the user selects an item from the select list.
<P><h3>Preferences</h3> The preferences screen is where users can change
their vital data, current active projects, and defaults.
<P>The preferences screen uses Java Script functions to ensure that all
entries are valid and that a user's default project is also one of her/his
active projects. Clicking save changes causes the information to be updated
in the database and forces a reload of the user's preference information.
<P><h3>Admin</h3> The admin section uses forms to allow users to perform
a variety of functions. This section of the application can only be accessed
by users who have admin privileges.
<P>The admin screen uses Java Script to ensure that a user has chosen an
item to edit before clicking the submit button. Each of the screens in
the admin interface also uses Java Script to validate user input. For groups,
projects, and work types, a Java Script function called when the user clicks
Save checks that the name of the item is not already being used. Names
are also checked for length limits and illegal characters.
<P>A delete button is only displayed if the item can be deleted without
violating database integrity constraints. This is determined as the page
is generated by querying the database about the existence of items which
would prevent a legal delete.
<P>After adding or editing an item, the default status line message is
set to a message reflecting the change with the onLoad event handler. The
onUnload event handler is used to turn the message off once the user leaves
the page.
<P><A NAME="dbschema"></A><H2>Database Schema</H2>
<P>&nbsp;
<DL>
<DT><B>category</B> table
<DD>unique ids and names of types of work
<DT><B>group</B> table
<DD>unique ids and names of groups
<DT><B>group_people</B> table
<DD>user ids and group ids which specify group affiliations for users
<DT><B>hours</B> table
<DD>hours entries: date, user, number of hours, project, category, and
description
<DT><B>project</B> table
<DD>unique ids, names, active status, and billable status of projects
<DT><B>user</B> table
<DD>user information: id, login, password, name, title, phone, email, active
status, full/part time status, admin privileges, default project and default
category
<DT><B>user_projects</B> table
<DD>user ids and project isd which specify the active projects for users
</DL>
<P>&nbsp;
</UL>
<H2>Soporte t&eacute;cnico y servicios.</H2>
<UL>
<P><CENTER>&nbsp;</CENTER>
</UL>
</BODY>
</HTML>
Reference in New Issue View Git Blame Copy Permalink