Documenti di Didattica
Documenti di Professioni
Documenti di Cultura
| Mamook(R) Software |
+------------------------------------------------------------------------------+
| Copyright (c) 2000-2005 University of Victoria. All rights reserved. |
+------------------------------------------------------------------------------+
| THE LICENSED WORK IS PROVIDED UNDER THE TERMS OF THE ADAPTIVE PUBLIC LICENSE |
| ("LICENSE") AS FIRST COMPLETED BY: The University of Victoria. ANY USE, |
| PUBLIC DISPLAY, PUBLIC PERFORMANCE, REPRODUCTION OR DISTRIBUTION OF, OR |
| PREPARATION OF DERIVATIVE WORKS BASED ON, THE LICENSED WORK CONSTITUTES |
| RECIPIENT'S ACCEPTANCE OF THIS LICENSE AND ITS TERMS, WHETHER OR NOT SUCH |
| RECIPIENT READS THE TERMS OF THE LICENSE. "LICENSED WORK" AND "RECIPIENT" |
| ARE DEFINED IN THE LICENSE. A COPY OF THE LICENSE IS LOCATED IN THE TEXT |
| FILE ENTITLED "LICENSE.TXT" ACCOMPANYING THE CONTENTS OF THIS FILE. IF A |
| COPY OF THE LICENSE DOES NOT ACCOMPANY THIS FILE, A COPY OF THE LICENSE MAY |
| ALSO BE OBTAINED AT THE FOLLOWING WEB SITE: http://www.mamook.net |
| |
| Software distributed under the License is distributed on an "AS IS" basis, |
| WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for |
| the specific language governing rights and limitations under the License. |
+------------------------------------------------------------------------------+
| Filename: contact_table_documentation.txt |
+------------------------------------------------------------------------------+
This file's purpose is to document all of the tables currently used in Mamook[tm]
by the
contact module.
Table Name
Table's Purpose
Column Name
Column's Purpose
etc.
-----------------
etc.
Purpose: This table stores all of the size ranges that a company can be associated
with.
Column Name: size_id
Purpose: This field is the id number used to keep track of different size
ranges. This is the primary key for the table.
Purpose: This field is simply the actual range of the corresponding size
range.
Eg. 50-200
---------------------------------------------------------------------------------
Purpose: This table stores all of the available company flags that co-op
departments
can choose to have enabled or not. Eg. If there are 16 flags in total, the
engineering
department may choose to have 10 of those flags shown on their company information
screen, and have 5 of those flags turned on, and 5 turned off.
Purpose: This field is the id number used to keep track of the different
flags. This is the primary key for the table.
Purpose: This field is used to provide a description for this flag, and is
transparent
to the mamook system (only used for database administration).
---------------------------------------------------------------------------------
Purpose: This table stores all of the employer flags from the company_flags table
that each co-op department would like to be able to set for companies.
Eg. There are 16 flags in total in the company_flags table. Engineering co-op
chooses
to have 10 of those flags shown on their company informatin screen, so this table
keeps a link for engineering co-op's department id and the flag id's for each of
the
10 chosen flags.
Purpose: This field is the id number of the flag that is associated with
the department represented above by its department_id.
---------------------------------------------------------------------------------
Purpose: This table stores all of the employer flags from the company_flags table
that each co-op department would like to be able to set for departments.
Eg. There are 16 flags in total in the company_flags table. Engineering co-op
chooses
to have 4 of these flags shown on their department information screen, so this
table
keeps a link for engineering co-op's department id and the flag id's for each of
these
4 chosen flags.
Purpose: This field is the id number of the flag that is associated with
the department represented above by its department_id.
---------------------------------------------------------------------------------
Purpose: This table holds all of the information for a company in the database.
Purpose: This field holds the address for the corresponding companies
website.
Purpose: This is the second part of the street address for this company, in
case a second field is needed.
Purpose: This is the third part of the street address for this company, in
case a third field is needed.
Purpose: This is the city that the company resides in/operates out of. This
will most likely be for its head office.
Purpose: This is the id number for the region of the province that the
company resides in/operates out of. This field is only relevant for
companies that operate in certain provinces of Canada.
Purpose: This is the id number for the province or state that the company
resides in/operates out of.
Purpose: This is the id number for the country that the company resides in/
operates out of.
Purpose: This is the phone number for the company. This will most likely
be the phone number to the head office, as contacts will hold phone numbers
specific to themselves.
Purpose: This field stores the most recent reason that the company
information was changed by a co-op staff member. This field is
necessary, since contact and company information will be shared
campus wide.
Column Name: change_reason_2
Purpose: This field stores the second most recent reason that the
company information was changed by a co-op staff member.
Purpose: This field stores the third most recent reason that the
company information was changed by a co-op staff member.
Purpose: This field stores the date that the most recent
changes to this company's information were made. This date
corresponds with the change_by_1 and change_reason_1 fields.
Purpose: This field stores the date that the second most
recent changes to this company's information were made.
This date corresponds with the change_by_2 and change_reason_2
fields.
Purpose: This field stores the date that the third most
recent changes to this company's information were made.
This date corresponds with the change_by_3 and change_reason_3
fields.
Purpose: This field holds the date that this company was
entered into the database.
Purpose: This field is a foreign key that represents the primary industry
that this company is a part of.
Purpose: This field is a foreign key that represents the relation of this
company
to the government (the key points to the employer_type table)
Purpose: This field is not currently used, but can be used along with code that
has
been disabled to indicate whether or not the company name is legitimate. This
is
a useful feature for data cleanup.
---------------------------------------------------------------------------------
Purpose: This table holds comments for companies that are specific to a single co-
op
department. This feature is currently disabled.
Purpose: This field holds the id number of the employer that these comments
are
for.
Purpose: This field holds the id number of the department that these comments
belong to.
Purpose: This field holds the actual comments (belonging to the department
and
associated with the employer given above).
---------------------------------------------------------------------------------
Purpose: This table holds information for the departments of a given company. Much
of this information is similar to that which is stored in the employer_company
table.
NOTE: This table is named employer_department, but it really represents a division.
Employer department's changed their name to 'Divisions' late into the
implementation
of this module, and so many of the names remain as department. Poor, but alas,
no time to fix this currently.
Purpose: This field holds the id number used to keep track of all of the
divisions. This is the primary key for the table.
Purpose: This field holds the id number that corresponds to the company
that this division belongs to.
Purpose: This field holds the name of the city that the division
operates out of.
Purpose: This field holds the most recent reason that the division's
information was changed by a co-op staff member.
Purpose: This field holds the third most recent reason that the
division's information was changed by a co-op staff member.
Purpose: This field holds the login_id of the most recent staff
member to change this division's information. This field corresponds
to change_reason_1.
Purpose: This field holds the login_id of the second most recent
staff member to change this division's information. This field
corresponds to change_reason_2.
Purpose: This field holds the login_id of the third most recent
staff member to change this division's information. This field
corresponds to change_reason_3.
Purpose: This field holds the date of the most recent change(s)
made to this division's information. This field corresponds
to change_reason_1 and change_by_1.
Purpose: This field holds the date of the second most recent
change(s) made to this division's information. This field
corresponds to change_reason_2 and change_by_2.
Purpose: This field holds the date of the third most recent
change(s) made to this division's information. This field
corresponds to change_reason3 and change_by_3.
Purpose: This field is a foreign key that represents the primary industry
that this division is a part of.
Purpose: This field is not currently used, but can be used along with code that
has
been disabled to indicate whether or not the division name is legitimate. This
is
a useful feature for data cleanup.
---------------------------------------------------------------------------------
Purpose: This table holds comments for departments that are specific
to a single co-op department.
Purpose: This field holds the id number for the employer department
that the comments in this record are for.
Purpose: This field holds the id number for the CO-OP department
that the comments are associated with.
Purpose: This field holds the actual comments (associated with the
employer department and co-op department).
---------------------------------------------------------------------------------
Purpose: This table holds all of the information for contacts of types: 'student',
and 'internal', and holds some of the information for contacts of types:
'employer',
'potential_employer'. As of right now, I'm unsure of how much information this
table holds for contacts of type 'alumni'.
Column Name: contact_id
Purpose: This field holds the id number that is used to keep track of
various contacts. This is the primary key for the table.
Purpose: This field holds the type of contact that this is. It can contain
one of the five above values. If the contact type is 'employer' or
'potential_employer', then there will be an entry in the table
contact_employer
that corresponds to this contact.
Purpose: This is the contact's title. This could be something like Mr.
Mrs., Dr., Ms., etc.
Purpose: This field holds the name the contact prefers to be called by.
Purpose: This field holds the way the contact is greeted in letters, etc.
Eg. Some contacts prefer to be called by their first name, while some
prefer to be addressed as Dr. 'last_name'.
Purpose: This field holds the first part of the contact's street
address.
Purpose: This field holds the second part of the contact's street
address (if there is a second part).
Purpose: This field holds the third part of the contact's street
address (if there is a third part).
Purpose: This field holds the id number of the country that the
contact resides in. Eg. If the id number for Canada is 1 and the
contact lives in Canada, this field will hold 1.
Purpose: This field holds the id number of the region that the
contact resides in. This field will only have a value if the
contact resides certain provinces. Eg. If the contact lives
in Greater Victoria, and its region id is 8, then this field
will hold an 8.
Purpose: This field holds the city that the contact resides in.
Purpose: This field stores the postal code for the contact's
mailing address.
---------------------------------------------------------------------------------
Table Name: contact_employer
Purpose: This table holds any extra information for contacts of type
'employer' or 'potential_employer' that isn't held in the contact
table.
Purpose: This field is now obsolete, and has been replaced with
the 'contact_types' and 'department_contact_status' tables, allowing
a status to be set for a contact for each co-op department. This
field should be removed when possible.
Purpose: This field is a legacy field left over from the transfer
of UVic's old data. It can be removed for other organizations,
of left if the organization wishes to write code to allow ownership
of contact's by different members at their organization.
Purpose: This field allows for a finer level of granularity to indicate the
contact's working department within the division they work for. Eg. The
contact could work for 'Northridge Consulting' as the company, 'West Coast
Office'
as the division, and 'Testing Department' as the department. This field
holds only a name, and is primarily used by system users rather than the
software itself.
---------------------------------------------------------------------------------
Purpose: This table holds all of the flags that can be turned on or off
for a contact in the contact_employer table.
---------------------------------------------------------------------------------
Purpose: This table stores all of the contact flags each department chooses to use.
Eg. There are 12 flags in total in the contact_flags table. Engineering co-op
chooses to have 7 of those flags shown on their company informatin screen, so this
table keeps a link for engineering co-op's department id and the flag id's of each
of the 7 chosen flags.
Purpose: This field is the id number of the flag that is associated with
the department represented above by its department_id.
---------------------------------------------------------------------------------
Purpose: This table stores comments for contacts that are specific to a given
co-op department. This feature is currently disabled throughout the software.
Purpose: This field stores the contact_id that the comments below correspond
to.
Purpose: This field stores the actual comments that correspond with the above
department_id and contact_id.
---------------------------------------------------------------------------------
---------------------------------------------------------------------------------
Purpose: This table is used to keep track of any additional information not stored
in the contact table that pertains to contacts that internal to the software
essentially users of the system, and other people working at the organization
running the system.
Purpose: This is the id number of the co-op department that this contact
works for. Eg. If a contact worked for Engineering Co-op, which had
a department_id of 4, this field would hold the value '4'.
Purpose: This is the login_id this user uses to login to the system at UVic,
using the netlink system.
Purpose: This column represents a boolean value that determines whether or not
the user can be assigned as a host in the assign lunch part of the interview
system.
Purpose: This field allows the user to default their search pages to either
an advanced or a basic search. A 1 in this field indicates that they would
like to default to the advanced search when searching for students.
Purpose: This field is a boolean value representing whether or not the user
would like to appear on work site visit pull down lists.
Purpose: This field allows the user to default their search pages to either
an advanced or a basic search. A 1 in this field indicates that they would
like to default to the advanced search when searching for employers.
Purpose: This field is the e-mail signature that this user will have
automatically appended to any mail that they send through the system.
Purpose: This field is the choice made by the user of whether they want to
default to Companies/Divisions or Contacts when they click on any of the
following Employer Info sections: view, add, edit.
---------------------------------------------------------------------------------
---------------------------------------------------------------------------------
---------------------------------------------------------------------------------
Purpose: This is the id number that corresponds (in the 'contact' and
'contact_employer' tables) to the contact that the flag below is set for.
---------------------------------------------------------------------------------
Purpose: This table is used to store all of the different action types
that can be performed on contacts.
Purpose: This is the id number that corresponds (in the 'contact' and
'contact_employer' tables) to the contact that the flag below is set for.
---------------------------------------------------------------------------------
Purpose: This table is used to store all of the notes users of the system have
stored for a given company.
Purpose: This is the id number that corresponds to the company that this
note pertains to.
Purpose: This is the contact_id of the user that entered this specific note.
---------------------------------------------------------------------------------
Purpose: This table is now obsolete. It used to be used to store all of the
notes users of the system had stored for a given contact. Contact notes are
now saved as part of the contact_actions_set table.
Purpose: This is the contact_id of the user that entered this specific note.
---------------------------------------------------------------------------------
Purpose: This table is used to store all of the notes users of the system have
stored for a given division.
Purpose: This is the id number that corresponds to the division that this
note pertains to.
Purpose: This is the contact_id of the user that entered this specific note.
---------------------------------------------------------------------------------
Purpose: This table is used to store the available types a company can be. The
types
correspond to different levels of government the company can belong to, such as
Federal Government, or Non Profit Organization. This field should probably
be renamed to something that makes more sense, like 'government_type' but their
currently is not time to do this.
Column Name: type_id
Purpose: This is the code that is used to display the various types in
drop down menus (so FG for Federal Government).
---------------------------------------------------------------------------------
Purpose: This table is where we store all of the actions that have been set for
contacts.
Purpose: This is a foreign key corresponding to the action that has been set
for the contact matched by contact_id
Purpose: This is a foreign key that corresponds to the contact that this action
has been set for.
Purpose: This is the contact_id of the person that performed this action.
Purpose: This is the date that this action took place on.
---------------------------------------------------------------------------------
Purpose: This table stores the statuses that co-op departments have set for any
given
company.
Purpose: This is a foreign key corresponding to the company that this status
has been set for.
Purpose: This is a foreign key that corresponds to the status that has been
set for this company.
Column Name: department_id
Purpose: This is a foreign key corresponding to the co-op department that has
set this status (since different departments can have different statuses for
the
same company/division/contact).
---------------------------------------------------------------------------------
Purpose: This table stores the statuses that co-op departments have set for any
given
contact.
Purpose: This is a foreign key corresponding to the contact that this status
has been set for.
Purpose: This is a foreign key that corresponds to the status that has been
set for this contact.
Purpose: This is a foreign key corresponding to the co-op department that has
set this status (since different departments can have different statuses for
the
same company/division/contact).
---------------------------------------------------------------------------------
Purpose: This table stores the statuses that co-op departments have set for any
given
division.
Purpose: This is a foreign key corresponding to the division that this status
has been set for (unfortunately, this relates to department_id in
employer_department,
not division_id :().
Purpose: This is a foreign key that corresponds to the status that has been
set for this division.
Purpose: This is a foreign key corresponding to the co-op department that has
set this status (since different departments can have different statuses for
the
same company/division/contact).
---------------------------------------------------------------------------------
Purpose: This table stores the flags that can be set for any given division.
---------------------------------------------------------------------------------
Purpose: This table stores the statuses that can be set for any given company.
---------------------------------------------------------------------------------
Purpose: This table stores the various industries that a company/division can be
involved with.
---------------------------------------------------------------------------------
Purpose: This table stores the various titles that can be set for any given contact
(Mr, Mrs, etc.)
Purpose: This is the name of title (so basically the title itself)
---------------------------------------------------------------------------------
Purpose: This table is only present in this release because the contact and base
modules
assume its existance.
---------------------------------------------------------------------------------
Purpose: This table is only present in this release because the contact and base
modules
assume its existance.
---------------------------------------------------------------------------------
Purpose: This table is only present in this release because the contact and base
modules
assume its existance.
---------------------------------------------------------------------------------
Purpose: This table is only present in this release because the contact and base
modules
assume its existance.
---------------------------------------------------------------------------------
Purpose: This table is only present in this release because the contact and base
modules
assume its existance.
---------------------------------------------------------------------------------
Purpose: This table is only present in this release because the contact and base
modules
assume its existance.
---------------------------------------------------------------------------------