02. User's Guide

Welcome

Welcome to the activeCollab User Guide.

This guide is designed to lead you through activeCollab from the moment you log-in for the first time through to the completion of your project.

By reading this guide, you will also learn how to get the most from activeCollab by harnessing its full potential.

Logging In

You don’t need any special software to access activeCollab. You can easily login using your web browser. Once activeCollab is installed, you can get started by simply entering your email address and password on the login page:

If you’ve forget your password for any reason, just use the Forgot Password link on the login page. You will be automatically emailed a link with a secret code that you will be able to use to create a new password and login again.

Note about Security

Even though you use a web browser to access activeCollab, all your data is completely secure and cannot be viewed or accessed by anyone else (including search engines, such as Google).

Your Profile

Everyone who uses your activeCollab is automatically given a User Profile, where they can add their name, contact information or upload a picture (and more!).

To view or edit your own profile, click on the profile link in the top-right corner of your activeCollab screen. From here you can see your current profile and add or edit any personal information as you choose.

Use the tabs on the right side of the screen to make changes:

  1. Update Profile - opens a new page where you can set your name, job title and contact details.
  2. Change Settings - lets you set your time zone, preferred format for dates and time, theme, etc.
  3. Change Password - create a new password for this account.
  4. API Settings - contains information (such as your API URL and API Key) that, when shared, enable other programs that support the activeCollab API to log-on your account.

Every user is also assigned a default picture when their account is created. To change it, click on the picture and upload a new image using the pop-up form.

Interface

After you successfully login, the main activeCollab interface will appear:

The main Interface has the following sections:

  1. User Control - ists your profile-related tools (Name, Profile access, Logout link). If you are the system administrator, the link to the Administration area will also be available here.
  2. Company Logo - By default, the activeCollab logo is displayed in the top-left of the screen, but it can be replaced with your company logo if you wish to brand your installation. Additionally, clicking the logo will return you to the Dashboard from any other page.
  3. Toolbar - gives you access to the most important sections and tools in the application (such as Projects, Invoice, Documents, Assignments).
  4. Page Information - displays the page title, author and time when a page was created (if applicable), plus other useful tools for that page.
  5. Workspace - where most of the action takes place. activeCollab displays project information in this area, as well as tools for handling Discussions, Files, Tickets and more.

There is also one important interface element that will be displayed when you visit specific projects - Project Tabs. These tabs allow you to easily navigate between all the different parts of the project.

Mobile Interface

You can access activeCollab even when you are away from your computer by using advantages of activeCollab Mobile Interace.

Mobile Interface is a part of a default activeCollab package (including both versions, Small Biz and Corporate) and it is enabled right after you install your system. When you access activeCollab from your mobile phone the system will recognize that you are using a smaller screen resolution and will offer optimized interface with a lower bandwidth.

Accessing Mobile Interface

Mobile Interface should be working out of the box right after you access your activeCollab. In case you have any difficulties, just add /m in the end of the link you are typing. For example: www.activecollab.mysite.com/m

You don't need to use any additional software to access activeCollab via Mobile device. All you need is a browser on that device that supports XHTML. You will be able to use your iPhone, Blackberry, Android or Symbian based phone without any troubles.

iPhone or iPod Touch Usage

Since we don't have an iPhone application developed, we recommend you to use Mobile Interface. It will detect that you are using iPhone or iPad and will make proper adjustments to enable you to use the advantages of the Touch Interface.

Dashboard

The first page that you'll see after you log in to your activeCollab is the Dashboard. It is designed to give a brief overview on what's going on with your projects, allow quick access to the latest Tickets, Files, Discussions, etc., and point out events that require your immediate attention.

Here are the tools that are available on your Dashboard tabs:

  1. Recent Activities - shows 30 most recent activities logged by the system, ordered by date with the latest on top. You can subscribe to this list and have the latest information in your RSS reader.
  2. Active Projects - displays a list of active projects you are working on.
  3. New and Updated - displays all events of interest that have occurred since your last visit.
  4. Late and Today - lists all the Milestones from projects you're involved with that are late or due today.
  5. Important Block - displays all important news that require your immediate attention.
  6. Favorite Projects - a list of active projects you have marked as 'favorite'. To add projects to this list, drag and drop a project into this box from the list of Active Projects.
  7. Who is Online - displays a list of users who have accessed activeCollab in the last 15 minutes.

Some of these tools won't be displayed if there is no data to show you. For example, if there's no new or updated objects since your last visit, the New and Updated tab will not be displayed.

Welcome Message

The first time you login to activeCollab you'll see a Welcome Message instead of the regular Dashboard.

The Welcome Message is there to offer some pointers and general advice to make getting started with activeCollab as easy as possible. Here you'll find tips on: configuring the system for your needs; adding clients and people you'll be working with; creating and defining new projects; and much more.

To hide the Welcome Message and display the real Dashboard, simply click on the Hide Welcome Message button on the top-right of the screen.

Managing People

activeCollab is not just a project management system, it's also a great collaboration tool. In order to realize the full project collaboration potential of activeCollab, you'll want to get everyone else on your project team using the system.

To start adding other users straight away just click the People button on the Toolbar:

When users are created they are are organized into Companies. Each company can have an unlimited number of members.

You can create as many companies as you wish. If you are not working with other companies though, you can use the company feature to organize people by department, group, team or any other grouping that is established in your organization.

However, one company will always be different: the company who created the installation. This company is known as the Owner Company.

Creating Companies

To create a new company in the People Section, click on the New Company button, enter the company details and click Submit.

After the company is created, you will automatically be redirected to the Company Details page, where you can add new users to that company. When you've finished adding people, the page should look something like this:

Creating User Accounts

To create a new user account, simply click the New User button on the Company page.

When you are creating a new user, only two fields are required: userʼs email address, and the role that user will have in the system.

Optionally, you can also:

  1. Enter profile details, like first and last name, company title, etc.
  2. Set a password for the user (if you don't set a password, then activeCollab will automatically generate a random password for that user.)
  3. Send a personalized welcome message with login details to the user. This message can be sent when the account is created, or at any point in the future, from the userʼs profile page.
  4. Assign the user to be automatically added to all new projects as they are created. This saves a lot of repetition later on when you know that a particular user is going to be involved in all future projects.

When a new user account is created, activeCollab will display the user's profile page. From here you can upload a picture or avatar for the user, re-send the welcome message, add the user to existing projects and more.

Adding People to More than One Project at Once

activeCollab lets you add users to multiple projects at once, a feature that can come in especially handy when someone new joins your team.

To do this, simply go to the user's Profile Page and from the Options drop-down select the Add to Projects option, as shown in the following screenshot:

On the newly-opened page, select the projects that you would like to add the user to and their Project Role or set of custom permissions that they should have). After you have set everything up, click the Submit button, and they will be assigned to all of the projects that you have selected.

Roles and Permissions

When you're working on a project, you might not want everyone to be able to see everything in it.

That's why activeCollab requires every user to have an account and a defined role which determines what the user can see and access inside your activeCollab setup. By correctly using the roles and permissions functionality though, you can relax knowing that any confidential project data will not be disclosed to anyone it shouldn't.

activeCollab has two groups of permissions that control who can access certain parts of the system:

  1. System Permissions lets you configure what a user can do in the system - eg. access administration controls, manage people or projects, create and access assignment filters, etc.

  2. Project Permissions enables you to give or restrict access to specific sections and features inside a project. One great thing about project permissions is that they work on a per-project basis. For example, you may want a user to be able to start new Discussions in one project, but you don’t want to give them access to Discussions in another project.

Manage Roles

Permissions are controlled in the Roles area, where System Roles define system-level permissions and Project Roles define project-level permissions. To manage roles, go to the Administration panel, and select the Roles tool in System section. You can learn more about Roles management in the Roles and Permissions article of our Administrator's Guide.

Each user can only have one System Role that controls what he or she can do on a system level. This role is set when the user account is created and can be changed at any time on the Profile page of the given user in the Company and Role option.

Unlike system roles, each user can have as many different project roles as projects they are working on (though only one Project Role per project). The Project role is set when the user is added to the project, via the People tab.

Assignments

When you are working on multiple projects at the same time, being able to see all your tasks in one place is important. activeCollab offers a tool that does just that - the Assignment tool- available at any time by clicking the Assignment button in the toolbar.

On this page youʼll find a list of all your assignments. If you wish to see a more specific list of your duties, you can use predefined filters (All, Late, Today) by choosing from the drop-down menu.

If none of these filters suits your needs, you can create a custom assignment filter by clicking on the New Filter button. A new page will open allowing you to filter assignments based on the following criteria:

  1. Who is assigned to work on the Task, Ticket or Milestone.
  2. When the assignment was created.
  3. When is a due date of the assignment.
  4. You can even check when some tasks were completed.
  5. Define the Project that assignment belongs to.
  6. Current status of the assignment.

By using different combinations of the available options you should be able to create as many different filters as you need.

Who can manage Assignment Filters?

Only users with manage_assignment_filters permission in their System Role will be able to create, change or delete existing filters.

The number of assignments displayed on the page and how they are ordered can also be configured for each filter.

If you want to create a filter just for your own use, simply mark the filter as Private and it will be hidden from other users.

Managing Projects

In activeCollab, all work is done within Projects. To start a new Project, or join an existing one, click the Projects button in the toolbar.

Groups and Clients

Projects can be organized in two ways - by Group or by Client. Whether you use one or both of these classifications is entirely up to you. By default, Projects are organized by project Group, but you can switch to sorting by Client by clicking on the Clients option above the project list.

Each company you define in the People section can also be a client. If a client is not specified when you create a Project, that Project will be considered an internal project and the system will behave as if the Owner Company is the client.

If you prefer a Group view, click on the Group button and you'll be able to see currently defined groups as tabs on the right side of your workspace. By clicking on the Group tab, the system will display only Projects that belong to that group.

To manage project groups, click on the Manage Groups tab at the bottom of the list. This opens a simple dialog where you can create new groups or rename / delete existing ones:

Everything that you do here will automatically be applied to the Group Tabs on the page.

Project Group Visibility

Not all project groups are visible to all users. To determine which project group it should display, activeCollab uses the following rules:

  1. User with the System Role that has admin_access or project_management permissions set to Yes will be able to see all project groups.
  2. Other users will see only Project Groups which contain projects they are working on. All the other groups will not be visible to them, and they will not be able to access them.

Project Groups ignore Project Status. That's why some users may be able to see a group even if there are no active projects in it, as it may contain other projects with a status of Completed, Canceled or Paused. The same rule also applies when you wish to delete a project group, and you will not be able to do so unless you first remove all projects from it.

Creating a New Project

To create a new project, simply click the New Project button.

Each project needs to have a name and a Project Leader. The Project Leader is the person responsible for all actions in the project and will automatically receive notifications about each and every new event that takes place. This person will also be assigned full permissions for the project, regardless of their current Project Role settings.

When creating a new project, you can either make one from scratch or by using a Project Template:

Any project can be used as a template for a new one. Just select it from the Project Template drop-down list when creating a new project, and activeCollab will copy all the Milestones, Tickets and Tasks from the template to the new project. activeCollab will even alter due dates of the tasks to reflect the differences between start dates of the template and new project if these dates are set.

Once you click the Submit button the new project will be created, and youʼll be redirected to the People tab of your project where you'll be able to add everyone else who will be involved.

Project Statuses

There are two types of projects in activeCollab:

  1. Active projects are projects that are being worked on at the moment. These projects will appear in the Jump to Project dialog, will be listed in the Active Projects tab of your Dashboard, and Dashboard updates will still be provided for these projects etc.
  2. Archived projects are projects that are no longer being worked on. They exist in the system, all data is still there, but they will not be displayed on the Dashboard, in the Jump to Project dialog, etc. The only way to access these projects is through the Archive link available at the bottom of Projects page.

activeCollab supports four project statuses:

  1. Active - As explained above.
  2. Paused - This status is used for projects that are on hold. Although paused, projects are not marked as completed. They are simply archived to avoid distraction.
  3. Completed - Projects that have been finished will be in this section. All completed projects will be available in your Archive, marked as completed and archived.
  4. Canceled - These are Projects that have been created and then, for one reason or another, stopped. They will be marked as completed and archived.

The status of a Project can be changed at any time by selecting Change Status from the Options drop-down that is available on the Project Overview page:

Quickly Accessing Projects

Besides browsing the Projects section, you can also use the following tools to quickly access all of your projects:

  1. Active Projects tab on the Dashboard lists all active projects you're involved in.
  2. Favorite Projects box on the Dashboard lists all projects you have marked as a favorite.
  3. Jump to Project dialog will pop-up when you click the small drop-down menu icon next to the Projects button in the toolbar. Choose the project you need and you'll jump straight there.

Working on a Project

Now we're going to look at project objects, or project tabs, as they are displayed in activeCollab. Each tab is a specific tool that enables you to organize your project in the way that works best for you. It's completely up to you to choose which set of tabs are you going to use.

Overview

The first project tab is the Project Overview page, which is named after the project you're working on. The purpose of this page is to keep you informed with everything going on in that particular project, including:

Project overview page displays:

  1. Project Details such as the project name, summary, status and client. From this area you can easily access manu common tools, like an RSS feed of the project activities, the project calendar, or a list of your assignments for that project.
  2. Recent Project Activities displays a list of latest activities from the project. You can also subscribe to this as an RSS feed and have fresh news on project activities update automatically in your RSS feed reader.
  3. Project Progress displays a project progress bar based on the number of completed and open Tasks, Tickets and Milestones in the project.
  4. Late and Today Milestone displays Milestones that are due and overdue. This box gives a brief overview of anything urgent in the project.
  5. People in This Project displays every person who is working on the project and the last time they logged in to activeCollab.

Checklists

Checklists are simple task lists. In order for a Checklist to be completed, each task on it must be finished.

To see all the Checklists in a project, click on Checklists tab. Checklists are ordered by their time of creation, but you can also change their order by dragging and dropping the Checklist to the desired position.

To see the list of tasks within any Checklist, simply click the Little Arrow icon next to it and the list will expand. You can also see the same information by clicking the Checklist's name to access the Checklist details page where all information relating to it, including Tasks, will be displayed.

You cannot assign a Checklist to a team member. You can, however assign individual tasks within that Checklist to an individual, allowing you to have more than one person working on a single Checklist.

When you are on the Checklists tab and you have two or more checklists expanded, you can drag and drop tasks from one checklist to another.

Rememeber, Checklists are only considered complete if all tasks on it are completed. By adding a new task to a completed checklist it will be re-opened automatically.

All completed Checklists are automatically archived. To browse them, simply click the Archive link at the bottom of the Checklist page.

Calendar

Due dates for Milestones, Ticketsfor each project can also be seen in a calendar view. Just click the Calendar tab for this useful overview:

The Calendar is automatically adjusted by activeCollab depending on the person viewing it, only displaying data (e.g. milestones, tickets or tasks) that this user would normally have access to.

To zoom-in on a particular date and see more details for that day's activities, just click on that date in the Calendar. To zoom-out and return to the previous view, click on the same date again.

The Calendar module also allows data to be exported in iCalendar format, meaning that you can easily export and synchronize data from activeCollab with your favorite calendar application (Windows Calendar, Apple iCal, Google Calendar etc).

Milestones

Milestones mark important deadlines or phases in your project. For example, if you're developing a website, a Milestone can be an important meeting or a review, the initial design process, presentation to the client or launch date. A Milestone can be a single date (deadline) or a period of time during which a certain phase of the project is developed.

Project milestones are listed on the Milestones tab:

Milestones are sorted by the time they are due. You can also use the iCalendar feed to import a summary of Milestones into your favorite calendar application.

To get more detail on any Milestone just click on a particular one from the list to open the Milestone detailpage. This page shows all Milestone-related information and any other project items that are related to it. Project items that can be filed under a Milestone include Checklists, Discussions, Files, Pages and Tickets. Linking Milestones and other project items together in this way allows other members of the project team to easily see which part of the project their tasks relate to.

1. Creating a Milestone

To create a new milestone, simply click on the New Milestone button:

Just add the Milestone name, a start date and due date and your Milestone is ready to go. However, if you wish, you can also add some notes, set a priority for the Milestone and add some tags to help describe it. If the Milestone is a single-day event, simply set both the start and due dates to be the same.

Unlike most of other elements in the project, Milestones can't be marked as private. Instead, all Milestones are visible to everyone involved with the project who has access to the Milestones section.

2. Rescheduling Milestones

Sometimes of course it's necessary to reschedule a milestone and that's where activeCollab comes in really handy. That's because when any milestone is rescheduled in activeCollab, all successive milestones, related items and tasks can also be automatically scheduled relative to the new time range as well.

To reschedule a milestone, simply select the Reschedule link from the Options drop-down menu on the Milestone details page:

The Reschedule form gives you an opportunity to set the start and due dates of all successive Milestones. By default, activeCollab will not change the start or due dates of successive Milestones and related project items, but you can override this simply by choosing the appropriate options on the Reschedule form. If you decide to do this, activeCollab will then automatically reschedule all related Tasks and successive Milestones.

Files

The Files area of activeCollab is designed to allow people to share project files, discuss them, work on them together, post new versions and much more. To access this section, simply click the Files project tab.

Files are ordered by the time they were uploaded, with most recent at the top. activeCollab displays an icon next to each file based on it's file type, making it easy to identify different types of files. If the file is an image (e.g. JPG, GIF or PNG) then activeCollab will display a thumbnail instead of the icon. To view or download an image file, simply click on its thumbnail image.

Click on any file name to visit the File page and view more details, including older versions and comments.

1. Uploading Files

This form enables you to upload any number of files at the same time.

While also:

  • setting their description;
  • notifying people;
  • placing them under a specific milestone;
  • categorize and tag them; and
  • choose whether they will have public or private visibility.

You also have the useful option of being able to notify people about newly-uploaded files. activeCollab will also send notifications to these subscribers whenever a new comment is made about a file or a new version of the file is uploaded.

Important Note

The file upload limit is not set by activeCollab; it is set by your own web hosting environment. You can learn in this article how to increase the maximum upload size of your files.

2. File Versions

If you wish to upload a new version of a file, simply use the New Version link on the Files page. A form will appear, and from here you can choose the desired file and upload it.

After the new version of a file is uploaded, the old one will not be removed; instead it will be kept in activeCollab for future reference. To access old versions of a file and all related details, visit the file's detail page.

3. Categories

Files may be organized into categories. All available categories are listed as tabs on the right of the files list. Click on a category to see all the files underneath it.

To manage categories, click on the Manage Categories tab at the bottom of the tabs list. A tool will pop-up, which allows you to create new categories or rename / delete existing ones.

Discussions

Each project in activeCollab has an area for discussion. To access it, click on the Discussions tab:

This part of activeCollab is similar to an online forum, with topics containing the most recent comments listed first. You can also mark some discussions as 'Important' and pin them to the top of the list.

1. Starting a Discussion

To start a new discussion, click the New Discussion button. On the following form you will then be able to enter the topic title, write a message, attach files and more.

At the end of the form you also have the option of notifying others that a new discussion thread has started. People you add here will also receive a notification each time a new comment is posted. Should the user no longer wish to receive these updates, then they can unsubscribe at any time.

2. Categories

Discussion Topics can also be organized by category. All available categories are listed as tabs on the right side of the page. Click any category tab to display the discussions that belong to that category.

To manage categories, click on the Manage Categories tab at the bottom of the list. A tool will then pop-up, allowing you to create new categories or rename / delete existing ones.

Tickets

Tickets can be used to make it easier for you to handle even the most complex jobs. Tickets can stand alone or be related directly to a Milestone. They can also have an unlimited number of attachments and comments and can be broken into smaller tasks.

When you click on the Tickets project tab, youʼll see the list of active tickets grouped by Milestone. If there are Tickets which are not related to a Milestone, they will be listed after the Milestones group, placed under Unknown Milestone at the end of the page.

Tickets are sorted by their creation time, but you can reorder them by dragging and dropping as you wish. You can even drag a ticket to another Milestone.

1. Creating a Ticket

To create a Ticket, click on the New Ticket button:

The only required field for a New Ticket is a ticket summary. However, you can also provide a full description; select a Milestone and Category; attach files; set a priority; add tags; pick a due date; and define a visibility level for that Ticket if you wish. Tickets can have any number of people assigned to them, but one person must be marked as responsible. All assignees will also automatically be subscribed to any updates to the ticket.

2. Categories

All tickets can be organized by category and all available categories are always listed as tabs on the right side of the Tickets list. To browse tickets for any category, simply click on the appropriate category tab name.

To manage categories, click on the Manage Categories tab at the bottom of the list. A tool that enables you to create a new ticket category, or rename and delete existing ones, will pop-up:

Time

activeCollab also comes with a handy tool that makes it easy for people to log how much time they have spent working on any project or task, as well as what they were doing and when. This information can then be gathered together by activeCollab and displayed as a time report, which can then be used for billing clients or paying employees.

To see all the time logs for a particular project, click the Time project tab. This lists all time records by time of completion, with most recent entries at the top:

1. Tracking Time

Time can be tracked on three levels:

  1. By Project.
  2. By Ticket.
  3. By Task. Tasks can be attached to Tickets, Pages or Checklists.

To track time on a Project directly, visit the Time tab in your Project, and enter the latest update using the form at the top of the page:

If you wish to track time at a Ticket or Task level then click the small clock icon available in the Ticket or Task detail section and insert the amount of time taken in the window that appears. This window also displays the number of hours already tracked for that particular Ticket or Task:

activeCollab Timer

You can also use activeCollab Timer, application for your time tracking. This desktop application, developed by our desktop development team, allows you to track time and submit it to your activeCollab setup quickly and easily. Both OS X and Windows versions of activeCollab Timer are available for download. To find out more take a look at the activeCollab Timer Guide.

2. Reports

The Time functionality can also be used to generate a range of useful reports from all the time records entered into activeCollab. Different criteria and rules can be used to customise each report to your needs. For example, you could create a report that will list all time that a particular team member has logged for the past week:

To be able to view and create time reports, a person must have the right permissions to do so (in this case, use_time_reports and manage_time_reports). If a user has these permissions, they will see both the Time button in their toolbar and Reports button within the Time project tab:

These tools behave exactly the same, but a single difference: the Time button in the toolbar runs reports against all projects, while Time tab in the project runs reports only for that specific project.

For your convenience, time reports can be exported in a CSV format, which can then easily be imported into any spreadsheet program, such as Excel or Google Docs, for additional processing. You can even create a New Invoice out of these reports by clicking the link in the bottom of the report page.

This Week and Last Week Filters

This Week and Last Week filters use First Weekday settings from the profile page of the user who is creating the report, however the reports only support weeks starting on Sundays or Mondays. If any other day is set in the user's profile, then Monday will be used automatically for the reports.

Pages

Pages is an area of activeCollab where your team can work together on text documents. In essence, a handy collaborative writing tool, which can be used for everything from short articles, such as blog posts, to longer documents, like books or product specifications.

To access this area, simply click the Pages project tab.

1. Create a New Page

To create a new page, simply click the New Page button. Here you will be able to set the page name and write the text itself. However, there are some other useful options too, such as the ability to set a parent page and Milestone (if any); attach files; add tags; define whether a page should have a normal or private visibility; and choose any people that should be notified that this new page has been created.

If you file a Page directly under a category, it will be treated like a new chapter inside of that category. On the other hand, you can file a Page under any other Page in the given category and System will treat it like sub-page of the initial page.

2. Organization of Pages

The first thing you'll see when you visit the Pages tab is a list of all pages, with the most recently edited or added documents at the top:

The main way of organizing Pages is by Category. To see all Pages from a category, and their original order, click on a category tab on the right side of the screen:

Set up Categories

General is the only default category included in activeCollab. You can create new categories at any time though: either in the Master Category tool (any new Categories added here will be available across every newly created project in your activeCollab); or via the Manage Categories tab (categories added here will be available for that project only).

When browsing a Category, activeCollab will display all Pages placed in that Category, organized in a tree structure. This means that top-level pages can have sub-pages; sub-pages can also have sub-sub-pages; and so on. This functionality is also great for working on more complex documents (such as a software manual or a book) as it allows you to organize the content in any way you want.

3. Reordering Pages

To quickly and easily reorganize pages, click the Reorder Pages button on the top right of any Page Category. This will open a form, allowing you to drag and drop pages to any position you want within your document structure:

When you are satisfied with the new order of your Pages, click the Submit button to save the changes.

4. Versioning

One of the most useful features of Pages in activeCollab is versioning - which automatically creates and stores an old version of the document every time a Page is updated. This feature is very useful for allowing you to see what has been changed in any previous version, as well as having each round of changes easily available for future reference.

To review the changes between the latest two versions, simply click the Compare Versions button and all the differences will be displayed by activeCollab. You can also make a comparison between any other two, older versions of the Page by selecting the version number from the drop-down menu at the top:

Combined with comments, versions makes Pages an excellent tool for all your collaborative writing and content creation.

Source

The Source Module brings a code repository directly to your projects. It allows code browsing, version comparisons and checking of the repository history. Additional functionalities, such as links between Tickets and Commits, Commit commands and more are also available.

At the moment, Source module can access only Subversion repositories.

1. Creating a Repository

When you start working with activeCollab's Source Module, the first thing you'll need to do is tell activeCollab where your repository is and how to connect to it. The number of repositories per project is unlimited, so you can have as many repositories as you want.

When adding a new repository you need to:

  1. Set the repository's name;
  2. Enter the root path to the repository (repository URL or direction);
  3. Type in your SVN password and username;
  4. Set how frequently do you want activeCollab to check for new revisions.

To check if your parameters are correct and ensure that activeCollab can reach the defined repository, use the Test Connection button.

Source Module configuration

You can find step-by-step instructions on how to set-up the Source Module in the activeCollab Tutorial, which is found the Configure Source Module article.

After you complete all of these tasks, click on the Submit button at the bottom of the page and your repository connection will be added to the project.

On the Source page, a list of all repositories will be displayed together with a graphical view of activities:

When entering a repository page you will get a preview of all commit messages grouped by date. By default, activeCollab only displays commit messages and the number of modified files, but you can also display paths of all added, modified and deleted files and folders for that commit with a single click by clicking the Show all paths button.

2. Browse Code and Commit History

Once a repository is created and configured, you will be able to browse through and see all folders and files within it:

By clicking on a file, you can see a history of all revisions to it, as well as being able to view all previous versions of that file and compare them. This can be done with the Revision Comparison tool, which marks new lines of code in green and deleted lines in red.

All files can also be downloaded in their original format.

3. Commit Messages

activeCollab can also parse commit messages and:

  1. Link Commit with Tickets, Tasks and Milestones. Recognized formats are: Ticket #ID, Task #ID and Milestone #ID where ID is the actual ID of that object.
  2. Close Ticket, Tasks and Milestones. The following formats are recognized: Complete Ticket #ID, Completes Ticket #ID or Completed Ticket #ID. These commands are also available for Tasks and Milestones.
  3. Display commits in the Ticket they are related to. The commit tab will allow you to see and access all files that are linked to that Ticket.

People

Each project in activeCollab can have as many people involved as you need. To easily view everyone working on the project at any time, simply go to the People project tab:

Regular members of the project team will only see a list of others who are working on the project. Anyone managing the project however will have additional controls to add or remove people from the project and to change any individual's project permissions.

1. Adding People

To add people to the project, click on the Add People button. A new page will be opened where you can select who should be added to the project and what project permissions you want the new team member to have:

Four different Project Permissions levels are available:

  1. No access;
  2. Can access, but canʼt create new objects;
  3. Can access and can create new objects;
  4. Can access, can create and manage all objects.

These permissions can also be set for each project object (Tickets, Discussions, Pages etc.) separately. This gives you a wide range of freedom in defining each user's project access. For example, you can give full permission to a user who is working with discussions, but not allow them to see tickets. You can learn more details on this in this article on Roles and Permissions article.

Permission Override

If a user is set as an Administrator, Project Manager or Leader of that particular project, then they will automatically get full permission to all areas of the project automatically. This will also override any permissions you set on the Add People page for them.

Email Notifications

activeCollab sends email notifications to all people involved with a specific Task, Ticket, Discussion, or File etc.

nlike some tools that email everyone about every small change to a project whether it is relevant to them or not, activeCollab is designed to avoid overwhelming people with too many email messages.

If users repeatedly receive messages on issues that are not relevant to them, it's likely that they will start to ignore all notifications send by the system. Because of this, activeCollab is designed to only email people who are subscribed to receive notifications about a specific object, instead of sending messages to everyone about every change.

1. Subscriptions

When a new File, Ticket, Discussion or any other object is created, the creator can define an initial group of subscribers. By default activeCollab automatically subscribes anyone assigned to a Task, Ticket or Milestone when one is created. For other objects, the creator picks the group of subscribers:

The project leader and any person who creates the object are always automatically subscribed.

After an object has been created, other project members can choose to subscribe to notifications about it if it is of interest to them. Existing subscribers can also unsubscribe themselves if they feel that specific object is not relevant to them.

Project Leaders and people who have permission to update objects can change the list of subscribers at any time:

There is one more automated action with subscriptions: activeCollab will automatically subscribe anyone who makes a new comment on an object, if that person wasn't subscribed already.

2. When are Notifications Sent?

Important Note

activeCollab will never send an email notification to the user that carries out a particular action (eg. created a new object, posted a comment, uploaded a file) in the first place. This ensures users never unnecessarily receive email notifications about something they just did (and therefore already know about).

activeCollab only sends out email notifications to users when:

  1. A New object is created. An email notification is sent to assignees of Tasks, Tickets and Milestones, or to the initial group of subscribers if an object does not have assignees (Discussions, Pages, Files etc). The Project Leader is also subscribed and notified.
  2. A Ticket, task or milestone are completed or reopened. All subscribers except the person who completed or reopened the assignment will be notified.
  3. A People assigned to ticket, tasks or milestone are changed. Both old and new groups of assignees are notified.
  4. A New version of a File or Page is posted. All subscribers except the person who posted the new version are notified.
  5. A New comment is posted. All subscribers except the person who made the comment are notified. The comment author is also automatically subscribed to future notifications if he or she was not subscribed before posting the comment.

3. Incoming Mail

With activeCollab's Incoming Mail feature you will not only receive email notifications from your copy of activeCollab, but will also be able to reply directly from your email software. This feature is especially handy for newcomers or people not logged in to activeCollab at that moment.

Incoming Mail setup

Since this User Guide is aimed at everyday use and functionalities of activeCollab, please refer to the Setup Incoming Mail article found in the activeCollab Tutorials to learn how to set up and configure Incoming Mail.

All you need to do is Reply above this line of the email you receive and activeCollab will do the rest.

activeCollab can create:

  1. New Comment - if your message is recognized as a reply to a notification about a new Ticket, Comment, Discussion, etc.
  2. New Ticket or Discussion - if the email is not in reply to a notification, activeCollab will carry out whatever action you have defined by default in the initial setup of the Incoming Mail Module, creating the appropriate item.
  3. An Attachment - from your email (whether in reply to a notification or a message designed to create a new object) will be posted as an attachment to a newly-created Comment, Ticket or Discussion.
Important Note

Be careful! Once imported, the message from your POP3 or IMAP server will be deleted. That is why we recommend that you create a separate email address for incoming mail, and not to use your usual personal or business email address.

Exporting a Project

activeCollab Corporate edition includes an optional module that enables you to export project information as a mini, static HTML website. Projects exported in this format do not require any web server to run (they can be opened with just a web browser) making them perfect for archiving projects.

Instal Project Exporter module

To install the Project Exporter module, go to the Administration > Modules page, and install it from the list of Available Modules:

Once the Project Exporter is installed, the Export Project option will be available under the Options drop-down menu on the Overview page of every project:

activeCollab also lets you pick which project data you would like to have exported:

Notes and Tips
  1. Before letting you export the data, activeCollab may ask you to create a /work/export folder on your server and set appropriate permissions so PHP can write to it.
  2. An option to prevent Project Exporter exporting private objects is also available. This feature is great for making archived copies of a project that you can burn to a CD and send to clients.
  3. Exported data is saved in /work/export folder.

Private and Normal Visibility

Project objects such as Files, Tickets, Pages, Discussions and Checklists can be marked as private:

Default Visibility

Default visibility for new objects is configurable on a project-by-project basis. If you set Default Visibility when creating a new project to be Private, then all forms used for creating new objects in that project will have Private visibility selected by default when you open them:

When an object is marked as private, it is visible only to people who have can_see_private_objects permission set to Yes in their System Role. Other people will not be able to see or access it.

For example, you have a user with a Member role who has the can_see_private_objects permission set to Yes. You also have one user with a Client Company Manager or Client Company Member role where can_see_private_objects permission is set to No. Both users have access to the Tickets section in a given project. When you create a Private Ticket in that project, only the user with a Member role will be able to see it because they have sufficient permissions, while the other users (those with a Client role) will not be able to see that ticket.

By default, only system roles that are used for members of the Owner Company (Administrator, Project Manager and Member) have can_see_private_objects permission set to Yes. This default setup is useful if you want to have a private discussion or create some private Tickets on a particular project issue, without your clients ever knowing about it.

Status

Status Module Installation

As one of the activeCollab's Available Modules Status is not enabled by default; it must be enabled after activeCollab is installed. Once enabled, you can then set up the Role which can use it. (only those users with can_use_status_updates can see the Status icon and use the Status Module).

Status is a simple communication channel which can be used by you, your team and your clients (if you decide to allow them access to this feature). You can post messages about your current actions, share site-wide notices or use it as a quick chat tool.

When you click on the Status icon, a pop up will appear, where you can post your Status updates:

When someone posts a new Status update, you will see an updated count of unread status messages, allowing you to always be notified of new events:

Invoicing

With the activeCollab Invoicing Module you can prepare and issue invoices directly from your project management software with no need to use any additional services or applications. An unlimited amount of storage space and having everything available in one place can definitely make managing your company's financials much easier. You'll have all your documents, reports and records saved and available for future reference, right at your fingertips.

Configuring Invoicing Module

Articles in this section are relate purely to everyday use of the Invoicing module. To learn how to configure tax rates, currencies, templates and more, please read the Invoicing section of the activeCollab Administrator's Guide.

Creating an Invoice

Permissions

In order to create an Invoice, you need to have the appropriate permission. Only users with can_manage_invoices permission can create a new invoice. By default, only administrators have this permission.

There are three ways to create an Invoice:

1. Manually

Invoices can be created manually, by completing and submitting the New Invoice form. Just follow the steps and fill in the blanks!

If you wish you can choose a Currency and Language. When you select a Company from the drop-down list, activeCollab will automatically load the company address that you have set in the People section. Additionally, you can select the Project you are creating the invoice for too.

The next group of fields allows you to list products and/or services that you are billing the customer for. Fill in the Unit Cost, Quantity, and choose the predefined Tax Rate. You can add several items to one Invoice. The system will calculate the Total, Subtotal and Total Due after you finish adding all your invoice items.

Invoice Notes can also be included with your Invoice. You can use a template, or enter a custom note. Notes will be visible on your PDF-issued Invoices as well.

Finally, you can provide an Invoice comment that is visible only to you, but not to the client. This field can be used for any additional information that you wish to track internally.

2. Based on a Time Report

While logging time, you can mark hours as billable:

Using Time Reports you can then run reports and see billable hours that match specific criteria. These reports can also be used to create an invoice, where all billable hours will be calculated together and multiplied with a default hourly rate that you have set for a given currency.

To create a new Invoice based on a time report, just click on the New Invoice link at the bottom of the report:

3. Based on the Ticket

Invoices can also be created from billable hours you track for a particular Ticket. A simple form will allow you to log time; create a short summary; and mark those hours as billable:

To create an Invoice from a ticket, visit the Ticket Details page and click on the Create Invoice link from the list of options on the right:

Issuing an Invoice

After you create your Invoice, it will be saved as a draft. To issue the invoice, click the Issue tab, which can be found on the right of the Invoice details page. On the page that follows you will thenbe able to set an issue date, due date and notify your client via email:

Important Note

Email notifications will only be sent to your client if a person from the Client Company has a Client Company Manager Role (or at least manage_company_details permission set to Yes). Printable PDF version of the invoice will be attached to the message. You will also receive a copy of the same email for reference and to keep track of everything your client receives.

Besides receiving an email notification, users with a Client Company Manager Role, will also see an Important box on their activeCollab dashboard showing that there are one, or more, outstanding invoices. They will also see the Invoice icon on the toolbar and be able to access the Invoice page where they will see all invoices issued to their company.

Auto-Numbering

If you have switched on auto-generate invoice number, activeCollab will automatically generate invoice numbers (based on the pattern you provided previously) whenever an invoice is issued.

Tracking payments

Once an invoice is issued, you can track and record payments against it. To do this, just click the New Payment link and type in the amount that has been paid. activeCollab will record it, noting how much of the total sum is paid, and how much is still outstanding.

Once the total amount is fully paid, the invoice will automatically be marked as billed and will be saved.

Duplicating an Invoice

Any invoice in activeCollab can be duplicated and used as a template for another. Using this simple feature frequently used invoices may be cloned to save time. To duplicate an invoice, simply click the Duplicate link from the invoice details page:

Documents

Setting up of Documents Module

Documents Module is one of the optional activeCollab Available Modules found in the in the Admin > Modules section. It can be installed quickly and easily by clicking the Install button on the right side of the screen. After installation, the Roles that can use the Documents must be defined. Remember that only users with can_use_documents permissions will have access to this feature.

The Documents Module allows you to create a repository of different types of documents and files. Documents are available globally, on the system level and everyone with the appropriate permission will be able to use and create them.

Documents are very similar to Files. Both have the same functionality, preview and file management options; but unlike Files, Documents are available on a higher level, outside and independent of any project. This feature can therefore be used to store company files (memoranda, privacy policies, contracts, company logos, etc.) or other documents of interest across the entire system.

A New Document can be created in two ways:

  1. as a New Text Document. Just type your document text in a Pages-like form, press Submit and it will be saved as a simple text document.

  2. by Uploading a File. The upload page will allow you to choose a file from your computer and upload it to the Documents area.

Documents are ordered alphabetically with activeCollab displaying a document type icon (or thumbnail if you upload an image) next to each document name. You can also create different Categories to allow you to sort and manage your documents any way you wish. Finally, as well as editing, deleting and downloading files, you can also pin them to the top of the Documents list.

Please remember that only the user who creates a document or an Administrator can manage documents and change document details. Everyone else can only view and download the document.

Documents marked as Private will only be visible to users authorized to see Private objects. This may be a handy feature if you wish to hide some documents from certain groups of users.

iCalendar Support

activeCollab can also export assignment data to calendar applications such as Microsoft Windows Calendar, Apple iCal, Google Calendar etc. This is done through a standard format know as the iCalendar format.

Data is exported in following way:

  1. Milestones are exported as VEVENT elements. This means they are displayed in your calendar application as an all day event, or as an event that spans a period of days.

  2. Tickets and Tasks are exported as VEVENT elements, as an all day event for the day when they are due.

Read Only Feeds

The iCalendar feeds that activeCollab exports are Read Only. This means that your favorite calendar application will be able to read and import the data, but you will not be able to change the data and have it automatically update back into activeCollab. Instead, to update the data, log into your activeCollab and change the data from there. Your calendar software will then automatically import the changes you made the next time it updates.

Subscribing to iCalendar Feeds

iCalendar feed links are available on the Global Calendar page, the Project Calendar page, and on the Overview page of the Active Projects list. These links are usually at the end of the page and you can spot them easily, because they are marked with a small calendar icon:

When you click on the link, the subscribe page will open:

activeCollab offers two types of iCalendar export:

  1. File download. This file will let you import the data into your calendar application, but the data will not be automatically updated when data in your activeCollab is changed.
  2. iCalendar feed. When you subscribe to the iCalendar feed, the data from activeCollab is imported in your calendar application. Additionally, your calendar application will then periodically check the feed for updates and refresh itself with the latest information.

activeCollab API and API Settings

The activeCollab API (or Application Programming Interface), is a set of methods that enables activeCollab to comunicate with another application. These methods are then used to read, edit and write data back in activeCollab.

You can find more information about activeCollab's API on your Profile page under the API Settings tab.

To establish a connection with another application you will need your API URL and API Key, both of which are available from the API Settings page.

One particular application that uses the activeCollab API is activeCollab Timer, in this application you need to input your API Key and API URL in order to create an account that will then send data from the application (in this case the amount of time spent on a specific task) back into activeCollab.

Want to know more?

If you wish to find out more about activeCollab's API you can find a series of articles containing detailed descriptions of all supported methods in our Developer's Guide.

Microsoft Project Importer (BETA)

Microsoft Project Importer module enables you to import data from Microsoft Project into activeCollab. Using the module you can import the following project data:

  • Name
  • Overview
  • Start Date
  • Milestones
  • Tickets
  • Tasks

Installation of the Microsoft Project Importer

At the moment Microsoft Project Importer is in a Beta testing phase, and as such it is not included in the default activeCollab setup. You can download it here.

After downloading it, you will need to extract the files and copy the folders within it to the respective part of the activeCollab root folder. If you are prompted to overwrite any files, please do so.

When this is done visit your activeCollab, where you will find the module in the Available Modules list on the Admin > Modules page. Just click the install button on the right; follow the on-screen instructions; and the activeCollab Microsoft Project Importer Module will be available for you in no time.

Import Projects from Microsoft Project to activeCollab

Once you have the activeCollab Microsoft Project Importer installed, you will find it under the Options drop-down menu of the Project Overview page.

Any user who has sufficient permission to create a new project in your activeCollab will also be able to use the Microsoft Project Import option.

To import a project, you will first need to export it from Microsoft Project as an XML file

Important Note

Importing projects from both Microsoft Project 2003 and Microsoft Project 2007 editions is supported.

To export a project as an XML file simply open the project you need within Microsoft Project, go to the Save As... option and make sure you select the XML File format. Now that you have the XML file, please visit the Project Overview page Options menu and click Import Microsoft Project option.

A new page will open where you can select the Microsoft Project XML file that will be uploaded. If the uploaded file is valid, you will be asked to select the data that you want to import into the project. After choosing the desired data, click the Import button and that data will then be saved.

In this way you can import data from any Microsoft Project to any of your newly created activeCollab ones.

WebDAV (BETA)

Web-based Distributed Authoring and Versioning (WebDAV) is a set of methods - based on the Hypertext Transfer Protocol (HTTP) - that allows collaboration between users when editing and managing documents or other files stored on World Wide Web servers. The WebDAV module in activeCollab is used to give access to activeCollab projects, categories and files in the Files module through a WebDAV client. Some common WebDAV clients are OSX Finder, Windows Explorer, Filezilla and Transit.

The WebDAV Module enables you to easily manage files:

  • see the folder structure of your projects;
  • view categories within a project;
  • manage files placed in each category.

All files can be easily moved, deleted or uploaded to your edition of activeCollab in this way. The permissions of each file within the project will also be copied to the WebDAV client so that only people who are authorized to manage files, or see private files in your system, will be able to do so using the WebDAV client.

Important Note

More information on how to configure and use WebDAV Module is available in this article of our Administrator's Guide

RSS

What is RSS?

RSS is a family of web feed formats used to publish frequently updated works, such as blog entries, news headlines, audio, and video in a standardized format. An RSS document (which is called a "feed", "web feed", or "channel") includes full or summarized text, plus metadata such as publishing dates and authorship.

What this means, in practice, is that RSS is a standardized XML document that programs such as RSS readers (or RSS aggregators) can interpet and use to provide you with automatic updates about a topic of interest to you. A popular RSS reader for Windows is FeedDemon. On Mac you can use NetNewsWire, Reeder and many more. Some email clients (Mail for Mac, Thunderbird, etc) can also read RSS and provide you with notifications.

If you prefer using RSS to be informed about new events, you will love the activeCollab RSS feed, and we offer a few types of information that you can receive in this way:

  • Global Recent Activity RSS feed - the link for this is available at the bottom of the Dashboard page. When you're subscribed to this feed you will receive notifications about all activities related to projects you're involved in.

  • Project Activity RSS feed - available in the Project Overview page. If you're subscribed, information about new project related activities will be posted in your RSS reader as they happen.

  • Assignments Tracking RSS - you can use this to track new tasks assigned to you across all projects by subscribing to the link at the bottom of the Assignment page.

  • Status Updates RSS - since the Status Module is designed to be used as a local activeCollab messenger, you might wish to have updates from this in your RSS reader. You will find the RSS feed link in the top right corner of the Status pop-up.