Modules

Modules group related work items within a project, such as the work for a feature, release, or campaign. Use a module to track that work with its own lead, members, dates, and progress. A cycle groups work by a time period, while a module groups work by a shared goal. Modules live inside a project. There's no workspace or teamspace view of modules.

Turn on modules

Modules are off in a new project. You can turn them on in the features step that follows Create project, or later in project settings:

1. Open your project's menu and select Settings.
2. Under Features, select Modules.
3. Turn on Enable modules.

A project created from a template takes the template's setting instead. Only project admins can change this setting, so if you cannot change it, ask a project admin. While modules are off, the project's Modules page says Modules are not enabled for the project. and offers a Manage features button.

Create a module

1. Open Modules in your project sidebar.
2. Click Add Module.
3. In the Create module dialog, enter a Title.
4. Optionally, add a description, dates, a state, a lead, and members.
5. Click Create Module.

You can also press N, then M to open the creation dialog. The dialog has a project selector in its header, so you can create the module in another project from there.

The title is required, can be up to 255 characters, and must be unique in the project. Dates use one date range picker, and you pick both a start date and a due date.

The Lead identifies the person responsible for the module. Members identifies the people involved in the work. Both come from the project's members. Module membership is separate from work item assignments, and being the lead doesn't give anyone extra permissions.

To change the module's title or description later, open its menu and select Edit. The Update module dialog has the same fields, and you save with Update Module. You can also change its state, dates, lead, and members in the details panel, and its dates and state from its row in the list or its card in the gallery.

Add work items

Open the module and click Add work item to create a work item in it. To add work items that already exist, click + on the work item list's header and choose Add an existing work item. A module with no work items shows Create work item and Add existing work item buttons instead.

You can also open a work item and select modules in its Modules property. A work item can belong to several modules in the same project. For instance, a work item can belong to both a feature module and a release module.

You can't add work items to an archived module, and archived modules don't appear in the Modules property. You can still remove work items from them.

Module states

Choose the module's state yourself. A module created through the form starts in Backlog unless you select another state.

State	When to use it
Backlog	You have identified the work but have not planned it.
Planned	The work is planned and has not started.
In Progress	Work is underway.
Paused	Work is on hold.
Completed	The module's work is finished.
Cancelled	You have stopped pursuing the work.

Change State in the details panel or use the status control in the module list or gallery. Completing work items does not change the module's state automatically, and a module can be Completed while some of its work items are still open.

Track progress

Click the info icon beside a module's name to open its details panel. Inside a module, open the same panel with the sidebar toggle in the header. Click the module's name to open its work items.

The panel starts with the module's description, then these sections:

• Properties shows the module's state, dates, lead, and members, and lets you change them.
• Progress shows the share of work items that are done, such as 4 of 10 work items done, with a bar and a count for each state group: completed, started, unstarted, backlog, and cancelled. When work items are overdue or blocked, a Needs attention area shows Overdue and Blocked counts.
• Breakdown shows the work by State, Assignees, Labels, or Priority. It opens on State and remembers the last tab you used for the module.
• Links lists links attached to the module. See Add links.

Progress counts the work items in a completed state, out of all the module's work items except cancelled ones. Archived work items aren't counted.

To inspect the work behind a number, click a state group in Progress or a row in Breakdown while the module's work item view is open. Plane filters the work items to match. Use Analytics in the module header for more work item charts, such as created versus resolved work items.

Add links

To attach a link to the module, click + in the Links section of the details panel. Enter the URL and, if you want, a Display title, then click Add link. Each link shows who added it and when. You can't add links to an archived module.

View and find modules

On the project's Modules page, choose List layout, Gallery layout, or Timeline layout. The list is the default.

• List layout shows each module in a row with its progress, date range, state, lead, a favorite star, and its menu.
• Gallery layout shows each module as a card with its work item count, lead, a progress bar split by state group, dates, and state.
• Timeline layout places modules against their dates. Drag a module, or either end of it, to change its dates. Admins can move any module, and contributors can move modules they created.

Use Search to find a module by name. The sort menu offers Name, Progress, Number of work items, Due date, Created date, and Manual. Except for Manual, you can sort in Ascending or Descending order.

Open Filters to narrow the list by Favorites, Status, Lead, Members, Start date, or Due date. The date filters offer presets from 1 week from now to 2 months from now, plus Custom.

Click a module's star to add it to your favorites. To share its URL, open the menu and select Copy link. Depending on the module and your permissions, the menu also shows Edit, Open in new tab, Export, Archive, Restore, and Delete. Right-click a module to open the same menu.

Archive a module

You can archive modules in Completed or Cancelled. For any other module, Archive appears in the menu but is turned off. Archiving preserves the module and its work items, and moves the module out of the main list. It also removes the module from everyone's favorites.

1. Open the module's menu.
2. Select Archive.
3. Click Archive in the confirmation dialog.

To find archived modules, open the project's menu, select Open archives, and open the Modules tab. To return a module to the main list, open its menu and select Restore. The module is restored right away, without a confirmation. Restore an archived module before you edit it.

Delete a module

You can delete any module, including an archived one. Project admins can delete any module, and contributors can delete modules they created.

WARNING

Deleting a module cannot be undone. The module and its progress view are no longer available. Its work items remain in the project, without a link to the deleted module.

1. Open the module's menu.
2. Select Delete.
3. Click Delete to confirm.

Archive a module instead if you need to keep its history.

Who can do what

Role	What they can do with modules
Admin	Everything, on every module in the project.
Contributor	Create modules, add and remove work items in any module, and export. Edit, archive, and delete only modules they created.
Commenter	View modules and add them to favorites.
Guest	No access to modules.

Export work items Pro

The export contains the module's work items and their properties, with the current work item filters applied. You need permission to export, which commenters and guests don't have.

1. Open an unarchived module.
2. Apply the filters you want to use.
3. Open the menu and select Export.
4. Choose CSV, Excel, or JSON.
5. Click Continue.
6. Click View Exports in the Export started message to open workspace Exports in a new tab.
7. Under Previous exports, click Download when the export is complete.

Export is also in each module's menu on the Modules page. See custom exports for more export options.