> ## Documentation Index
> Fetch the complete documentation index at: https://docs.mercora.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Modules

> Modules are the parts of Mercora your workspace uses. Admins turn them on and off for the whole workspace.

A module is a part of Mercora that your workspace can switch on or off: a surface like **Contracts** or **P\&L**, a workflow like **Hedging**, or a shared capability like **Copilot**. Modules let each workspace use exactly what fits how it works, and keep everything else out of the way.

Modules apply to the whole workspace. Whether a particular person can then see and change a module's data is decided by their role. See [How modules and permissions combine](#how-modules-and-permissions-combine).

## Turn modules on or off

> [!NOTE]
>
> **Before you start:** only workspace admins can change modules. Everyone else can see which areas they have in the sidebar; ask your admin to turn a module on.

**1. Open the Workspace settings**

Go to **Settings**, then under **Workspace** click **Workspace**.

**2. Find the Modules section**

Modules are grouped into **Core app**, **Workflows** and **Shared capabilities**. Each one has a short description of what it controls and what turning it off hides.

**3. Flip the switches you need**

Turn each module **On** or **Off**. The page shows "Unsaved changes" until you save.

**4. Save**

Click **Save changes**. Click **Reset** instead to discard your edits.

![The Modules list with the Core app group and modules nested under Trades](https://mintcdn.com/placeholder-f4ffdeec/22McaegbdDRSI41b/images/concepts/modules-settings.png?fit=max\&auto=format\&n=22McaegbdDRSI41b\&q=85\&s=04244738ad9ba7d825909618ba1ca1d4)

Modules in Veltana Commodities SA. Shipments (trade tab) and Trade financials nest under Trades, with Vessel Tracking and Cost & income plan one level further down.

Some modules sit under a parent module. A child module only works while its parent is on: when the parent is off, the child's switch is greyed out and reads "Requires" followed by the parent's name. Turning a parent off also turns off the modules under it.

For more on the rest of this page, see [Workspace settings](https://docs.mercora.io/admin/workspace-settings.md).

> [!TIP]
>
> Turning a module off hides it. It doesn't delete the data. For several workflows, work already in progress stays available to finish after the module is turned off, as noted in the tables below.

## Core app

| Module | What it does | Starts |
| - | - | - |
| **Dashboard** | The overview cards on Home. Each member only sees data their role allows. | On |
| **Document inbox** | Review and approve documents, and see document tasks, in the Inbox. | On |
|   ↳ **Bundle review** | When an upload holds several documents, hold it in the Inbox so someone confirms the split before the documents are read and matched. Off splits and processes them automatically. | Off |
| **Trades** | The trade book: trade list, trade details and document reconciliation. | On |
|   ↳ **Shipments (trade tab)** | The Shipments tab on a trade, with its vessels and containers. | On |
|     ↳ **Vessel Tracking** | Live vessel positions on a trade's Shipments tab. | On |
|   ↳ **Trade financials** | The Financials tab on a trade: receivables, payables and invoice reconciliation. | On |
|     ↳ **Cost & income plan** | Plan a trade's costs and income, settle them against invoices, and drive the trade's P\&L from the plan. Off, the P\&L uses contracted and invoiced amounts. | Off |
| **Contracts** | Purchase and sales contracts as standalone records, with optional pairing into deals. | Off |
| **Contract drafting** | Draft sales and purchase contracts from your own Word templates. Admins manage templates under **Settings → Contract templates**. | Off |
| **Document upload** | Upload trade documents by hand. | On |
| **Shipments** | Cargo movements across all trades (vessels, containers and trucks) with a route map and trade links. | Off |
| **Financials** | The workspace-wide list of invoices, shown as **Financials** in the sidebar. | Off |
| **Counterparties** | Buyer, supplier, broker and bank records with KYC, trading terms and balances. Off, buyers and sellers are typed in as free text. | Off |
| **Derivatives** | The futures ledger: fills, and allocating a fill against a contract. Needs **Counterparties** for the broker. | Off |
| **P\&L** | Realized and open margin by commodity, book and delivery month, in any currency. | Off |
| **Reports** | Operations, cashflow and overdue reports. | Off |
|   ↳ **Operations report** | Pipeline health, discrepancy aging and document completeness. | On |
|   ↳ **Commercial cashflow** | Cash-basis revenue and cost, with an ancillary-cost breakdown. | On |
|   ↳ **Overdue report** | Unpaid invoices past due, by counterparty. | On |

A child module marked "On" only takes effect once its parent is on. For example, the three reports are ready as soon as an admin turns on **Reports**.

## Workflows

Each workflow is turned on separately, and its access is granted separately in each role.

| Module | What it does | Starts |
| - | - | - |
| **Deal Capture** | Capture recap and contract terms from incoming email, or from a deal forwarded to the Copilot, for review in the Inbox, then confirm them to a trade or a connected system. Off stops new intake; existing work stays available to finish. | Off |
| **Freight Rates** | Carrier rate sheets, emails and notices go to Mercora, which proposes the exact changes to your freight master spreadsheet for you to confirm in the Inbox. Needs a connected freight master. | Off |
| **Hedging** | Review hedge plans received over WhatsApp, approve broker requests and record fills in the Inbox. Also needs a connected WhatsApp integration. | Off |
| **Automations** | Standing instructions that read the data they're permitted to see and report what they find. Off stops new runs; existing results stay available. | Off |

## Shared capabilities

| Module | What it does | Starts |
| - | - | - |
| **Copilot** | The AI assistant on Home. Each member also needs Copilot access in their role. | On |
|   ↳ **Agiblocks reporting** | Lets the Copilot read reporting data from a connected Agiblocks system to answer questions and build exports. Read-only. Members also need Reports access. | Off |
| **External systems sync** | Connect Mercora to an external system, such as your CTRM (commodity trading and risk management system), then choose which kinds of data Mercora may push. Off stops every push. | Off |
|   ↳ **Invoice sync** | Push invoice data to the connected system. | On |
|   ↳ **B/L sync** | Push bill of lading data to the connected system. | On |
|   ↳ **Contract sync** | Push a contract captured from an uploaded document. | On |
|   ↳ **Hedging sync** | Push hedge fills and allocations. | On |
|   ↳ **Deal Capture sync** | Push a recap or contract captured from email or the Copilot. | On |
| **QuickBooks Online** | Lets admins connect QuickBooks Online companies under **Settings → Integrations**. Disconnect companies before turning it off. | Off |
| **Microsoft 365** | Connect Microsoft 365 under **Settings → Integrations**, then turn on its parts below. | Off |
|   ↳ **Email** | The Copilot and automations can find and read email in the connected mailboxes, and send, reply, forward, draft and add calendar events after you click **Approve**. | Off |
|   ↳ **Files** | The Copilot and automations can find and read connected SharePoint files and spreadsheets, and change them after you click **Approve**. | Off |
|   ↳ **Teams** | Chat with the Copilot in Teams, bring deals posted in chosen channels into the Inbox, and let the Copilot and automations post after you click **Approve**. | Off |

See [Integrations](https://docs.mercora.io/integrations/overview.md) for how to connect these systems.

## How modules and permissions combine

A module being on doesn't give everyone access to it. To use a part of Mercora, a member needs **both**:

1. The **module** turned on for the workspace, and
2. A **role** that grants at least **View** on the matching permission (and **Edit** to make changes).

For example, if **Counterparties** is on but a member's role has Counterparties set to **None**, that member doesn't see Counterparties in the sidebar. If the role grants Counterparties but the module is off, they don't see it either.

A few areas collect work from several places and appear when any one of them applies:

* **Home** appears if the member can use either the overview cards (**Dashboard** module and permission) or the Copilot (**Copilot** module and permission).
* **Inbox** appears if the member has access to any enabled workflow that sends items there: documents, Deal Capture, Freight Rates, Hedging, or automation results.
* **Upload** appears if the member can upload documents, or can upload freight rate sheets through Freight Rates.

See [Roles and permissions](https://docs.mercora.io/concepts/roles-and-permissions.md) for the full list of permissions.

## Next steps

> **[Roles and permissions](https://docs.mercora.io/concepts/roles-and-permissions.md)**
>
> Decide who can view and change each area you turned on.

> **[Members](https://docs.mercora.io/admin/members.md)**
>
> Invite your team and give each member a role.

> **[Workspace settings](https://docs.mercora.io/admin/workspace-settings.md)**
>
> Company profile, reporting currency and the rest of the Workspace page.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.