What is Included

From DotProjectWiki

(Redirected from Module Descriptions)
Jump to: navigation, search

GENERAL INFORMATION

When you download and install dotProject you get the Core Modules or majority of the application. There are also a range of Add On Modules that are available.

  • Core Modules are those that are delivered as part of the basic product installation and that are supported / maintained by the Dev Team.
  • Add On Modules are functionality add ons that are developed and maintained separately from the Core Modules. The majority of Add On Modules developers not being members of the Dev Team and the status of these modules can often be variable. Some add ons are actively supported by their original developers and/or other interested community members, some are up to date, some are in limbo and not compatible with current dotProject versions. If you are interested in taking on maintenance and ongoing development of any Add On Modules please refer to Dev Team Invitations. The Dev Team are not expected to support Add-On modules unless they specifically volunteer to do so.

Contents

1 User and System Administration Manuals

This page provides a brief description of the available modules. For details on usage and/or configuration please refer to the User Manual and the System Administration manual sections.

2 Core Modules

The core modules that make up dotProject are the bare minimum that you need to manage a project and your dotProject installation. They all interrelate to varying degrees to build up a project repository. The following list is in alphabetical order for no particular reason other than an order is good.

2.1 Backup Module

New module as of 2.0 to create an XML backup of your dotProject database (NOT the program files / uploaded files etc). Very new and we currently don't recommend that you use this as your only security backup of dotProject.

2.2 Calendar Module

The Calendar module provides appointment functionality as well as by date views of tasks.

2.3 Companies

Companies are the entities that group projects, tasks and users together. You must have companies in order to be able to create other dotProject elements. See User Manual - Companies, Departments and Contacts for details.

2.4 Contacts

The contact module allows you to record names and addresses or contact records for associates. Contacts can be assigned to a project as a non-participant, who can be selectively sent task log updates. Contacts cannot login to dotProject. See User Manual - Companies, Departments and Contacts for details.

2.5 Departments

Departments are subsets of Companies, allowing you to group elements such as users at that level. At the moment there are few filters throughout dotProject at the Departmental level but some are being worked on. See User Manual - Companies, Departments and Contacts for details.

2.6 Files Module

Basic files module which allows you to store files against a project / within dotProject for access by project workers. There is some basic file versioning built into the Files Module.

2.7 Forums Module

Very basic discussion forums module provides facilities for creating forums against specific projects for recording discussions / notes / information.

2.8 Gantt Charts

Gantt Charts are incorporated into dotProject courtesy of the great project jpGraph. Charts are available at the individual project and all project levels.

2.9 History

The history module provides an audit trail or log of changes within your dotProject data.

2.10 Links

The links module allows you to record important or frequently used links for all users to follow.

2.11 Projects

Projects are the overriding elements within which tasks are performed. For example, you might say that you are using dotProject to manage the process of Building Your House, so you could have a project called "Our House". Within that project there are then specific tasks that you assign to various contractors / family members etc. See User Manual - Projects for details.

2.12 Reports Module

We're currently in the process of moving reports from within the projects module (and therefore many are hard coded to the "current" project) into a module of their own. Will not be available until dotProject Version 3.x

2.13 Resources Module

The resource module allows you to incorporate non-human resources into a project (eg rooms / equipment etc.)

2.14 Smartsearch

System wide search module - within individual "modules" there are search features, smartsearch works across all modules.

2.15 System Administration

System Administration includes all of the setup options, including establishing User Roles and Permissions.

2.16 Tasks

tasks are the actual work components or jobs assigned within a project. tasks are the components against which work is done, hours are recorded, updates (in the form of task logs are saved) and progress is updated.

2.17 User Admin

Module for management of dotProject users, able to login to your dotProject installation and work within the permissions scheme that you provide for them. What distinguishes a user from a contact is the application of a permissions role and therefore the ability to login.

3 Add On Modules

The following add on modules have been developed by community participants to add specific fragments of functionality.

3.1 Eventum Integration

There is a first draft of module for integrating Eventum and dotProject. There are some limitations in that logins cannot be automatically shared between the two packages, but the module does provide viewing of Eventum issues from within associated dotProject projects. Please make sure that you carefully read the installation instructions as if you are using dP2.0.1 you'll need to update some files from the stable_2 CVS to make the integration work. See Eventum for details.

3.2 Help Desk

There is an add on help desk module which has recently resurged into active support courtesy of one of the core development team who has offered to take on the task. The module was originally conceived as a replacement for Ticketsmith and has had a rather rocky history in terms of updates. It appears to now be powering ahead. See Help Desk for details.

3.3 Invoicing

There is an invoicing module that allows you to generate invoices from dotProject Task Logs See Invoicing for details.

3.4 Mantis Integration

3.5 Project Importer

There is a module that allows users to import their Microsoft Project files directly into dotProject keeping the dates, user assignments, and percent allocations. It is known to work with Microsoft Project versions '98 - '03 and dotProject 2.0.4. See Project Importer for details.

3.6 Ticketsmith

Ticketsmith is a third party legacy package that was incorporated in the initial releases of dotProject for handling incoming support tickets. As of release 3.0 Ticketsmith will become an add on module, deprecated from the core package and no ongoing bug fixes will be provided from release 2.x onwards. See Ticketsmith for details.

3.7 Timesheet

There is one active timesheet recording program on the dotMods project (plus some inactive ones so check before you grab just anything). See Timesheet for details.

--KarenC 15:40, 31 October 2006 (EST)

Personal tools
System Administration
Conversion