Contract Lifecycle Management — Features (Full Detail)

← Back to Contract Lifecycle Management overview

Features (Full Detail) — Contract Lifecycle Management

Current version: v1.0.0

End-to-end contract lifecycle tracking, stages, and governance for Perfex CRM

This page explains module capabilities in depth so new users understand what each feature does, why it matters, and how to use it inside Perfex CRM.

Feature catalog (explained)

Every major capability below is explained in plain language — what it is, why it helps, and how to use it.

1.

In plain words:

Why it matters: This helps your team complete the work faster with fewer mistakes and a clear audit trail inside Perfex CRM.

How to use it: Create a draft record, submit it, then have an approver open the same record and Approve / Reject. Approvers need the approve permission on their role.

2.

In plain words:

Why it matters: This helps your team complete the work faster with fewer mistakes and a clear audit trail inside Perfex CRM.

How to use it: Enable portal options in Settings, link the customer/supplier contact, then test with a portal login to confirm visibility and actions.

3.

In plain words:

Why it matters: This helps your team complete the work faster with fewer mistakes and a clear audit trail inside Perfex CRM.

How to use it: Enable credentials in Contract Lifecycle Management → Settings (API keys, webhooks, sandbox/production). Test with a sample record, then monitor the module log or sync screen.

4.

In plain words:

Why it matters: This supports compliance, audit readiness, and on-time operations so nothing important is missed.

How to use it: Open Contract Lifecycle Management in the admin sidebar, then use the related menu screen for this capability.

5.

In plain words:

Why it matters: This helps your team complete the work faster with fewer mistakes and a clear audit trail inside Perfex CRM.

How to use it: Open Contract Lifecycle Management in the admin sidebar, then use the related menu screen for this capability.

6.

In plain words:

Why it matters: This helps your team complete the work faster with fewer mistakes and a clear audit trail inside Perfex CRM.

How to use it: Enable credentials in Contract Lifecycle Management → Settings (API keys, webhooks, sandbox/production). Test with a sample record, then monitor the module log or sync screen.

7.

In plain words:

Why it matters: This helps your team complete the work faster with fewer mistakes and a clear audit trail inside Perfex CRM.

How to use it: Enable credentials in Contract Lifecycle Management → Settings (API keys, webhooks, sandbox/production). Test with a sample record, then monitor the module log or sync screen.

8.

In plain words:

Why it matters: This reduces manual work so agents can focus on exceptions and high-value customers.

How to use it: Configure under Contract Lifecycle Management → Settings, and assign staff access from Setup → Staff → Roles.

9.

In plain words:

Why it matters: This helps your team complete the work faster with fewer mistakes and a clear audit trail inside Perfex CRM.

How to use it: Go to Contract Lifecycle Management → Reports / Dashboard (or the matching analytics screen), set filters (date, status, warehouse, staff), then run or export the report.

10.

In plain words:

Why it matters: This helps your team complete the work faster with fewer mistakes and a clear audit trail inside Perfex CRM.

How to use it: Enable credentials in Contract Lifecycle Management → Settings (API keys, webhooks, sandbox/production). Test with a sample record, then monitor the module log or sync screen.

11.

In plain words:

Why it matters: This helps your team complete the work faster with fewer mistakes and a clear audit trail inside Perfex CRM.

How to use it: Enable credentials in Contract Lifecycle Management → Settings (API keys, webhooks, sandbox/production). Test with a sample record, then monitor the module log or sync screen.

12.

In plain words:

Why it matters: This helps your team complete the work faster with fewer mistakes and a clear audit trail inside Perfex CRM.

How to use it: Go to Contract Lifecycle Management → Reports / Dashboard (or the matching analytics screen), set filters (date, status, warehouse, staff), then run or export the report.

13.

In plain words:

Why it matters: This reduces manual work so agents can focus on exceptions and high-value customers.

How to use it: Ensure Perfex CRM cron is running (`php /path/to/perfex/index.php cron/index`). Then enable the related option in module Settings so jobs, alerts, or queues process automatically.

14.

In plain words:

Why it matters: This helps your team complete the work faster with fewer mistakes and a clear audit trail inside Perfex CRM.

How to use it: Go to Contract Lifecycle Management → Reports / Dashboard (or the matching analytics screen), set filters (date, status, warehouse, staff), then run or export the report.

15.

In plain words:

Why it matters: This helps your team complete the work faster with fewer mistakes and a clear audit trail inside Perfex CRM.

How to use it: Configure under Contract Lifecycle Management → Settings, and assign staff access from Setup → Staff → Roles.

Screens map — what each menu is for

These are the admin screens registered by Contract Lifecycle Management. Click a name in the Knowledge Base for a full how-to, or open the path in admin.

#ScreenAdmin pathGuide
1CLM Dashboardadmin/contract_lifecycle_managementHow to use
2Contractsadmin/contract_lifecycle_management/contract_lifecycle_management_contractsHow to use
3Lifecycle Stagesadmin/contract_lifecycle_management/contract_lifecycle_management_stagesHow to use
4Milestonesadmin/contract_lifecycle_management/contract_lifecycle_management_milestonesHow to use
5Amendmentsadmin/contract_lifecycle_management/contract_lifecycle_management_amendmentsHow to use
6Renewalsadmin/contract_lifecycle_management/contract_lifecycle_management_renewalsHow to use
7Approvalsadmin/contract_lifecycle_management/contract_lifecycle_management_approvalsHow to use
8Reportsadmin/contract_lifecycle_management/contract_lifecycle_management_reportsHow to use
9Settingsadmin/contract_lifecycle_management/contract_lifecycle_management_settingsHow to use

Features & workflows from documentation

Features (Complete — Phases 1–6)

  • Lifecycle Stages — Draft, Review, Negotiation, Approval, Active, Renewal Due, Expired, Terminated
  • Contract Registry — Full CRUD with client, project, value, dates, and contract types
  • Core Contract Sync — Optional auto-link to Perfex CRM core contracts via hooks
  • Stage Transitions — Full audit trail with notes and staff tracking
  • Milestones & Obligations — Delivery, payment, review, renewal notice tracking per contract
  • Amendments & Version Control — Contract changes with diff view, attachments, core sync
  • Renewals — Renewal proposals, approval workflow, decision tracking, RR sync
  • Approval Workflows — Multi-level sign-off, configurable rules, stage gates, email alerts
  • Reports — Expiry register, stage pipeline, value by client/type, milestone tracker, RR links
  • REST API — Token-authenticated read access to contracts and related data
  • Webhooks — Outbound events for stage changes, expiring contracts, and renewals
  • CSV Export — Export any report with applied filters
  • Automation — Cron for milestones, expiry alerts, auto-expire, renewal stage moves
  • Dashboard — KPI cards, stage chart, pending approvals, expiring contracts
  • Permissions — Granular staff capabilities per feature

REST API

Base URL: {your-crm}/contract_lifecycle_management/clm_api

Authentication: X-CLM-API-Key: {token} or Authorization: Bearer {token}

Enable under Settings → Enable REST API, then generate keys under API Keys.

Listing highlights

Official HTML documentation (feature sections)

2. How to Use

First setup (recommended order)

  1. Lifecycle Stages — Review seeded stages (Draft → Terminated). Edit names, colors, order if needed.
  2. Settings — Set contract code prefix (default CLM-), default stage, expiry alert days, sync options.
  3. Approval Rules (optional) — Define who must approve before certain stage moves.
  4. Create a Contract — Contracts → New. Select client, dates, value, type, and stage.
  5. Link Core Contract (optional) — Link a Perfex CRM core contract when sync is enabled.

Day-to-day workflow

  1. Open a contract and transition stages with notes (full audit trail).
  2. Add milestones for deliveries, payments, and review dates.
  3. Create amendments when terms change; attach files; approve and apply.
  4. Manage renewals before expiry; approve or mark not renewed.
  5. Use Approvals for multi-level sign-off with email alerts.
  6. Open Reports for expiry, pipeline, value, and milestone tracking; export CSV.
  7. Check the Dashboard for KPIs, pending approvals, and contracts nearing expiry.

3. Features

  • Lifecycle Stages — Draft, Review, Negotiation, Approval, Active, Renewal Due, Expired, Terminated
  • Contract Registry — Full CRUD with client, project, value, dates, and contract types
  • Core Contract Sync — Optional auto-link to Perfex CRM core contracts via hooks
  • Stage Transitions — Full audit trail with notes and staff tracking
  • Milestones & Obligations — Delivery, payment, review, renewal notice tracking
  • Amendments & Version Control — Diff-style changes, attachments, core sync
  • Renewals — Proposals, approval workflow, decision tracking
  • Approval Workflows — Multi-level rules, stage gates, email alerts
  • Reports & CSV Export — Expiry register, stage pipeline, value by client/type
  • REST API & Webhooks — Token auth + outbound events
  • Automation — Cron for milestones, expiry alerts, auto-expire, renewal stage moves
  • Dashboard & Permissions — KPIs and granular staff capabilities

4. Permissions

Assign under Setup → Staff → Roles:

Capability groupTypical actions
Dashboardview
Contractsview, create, edit, delete, transition
Stagesview, create, edit, delete
Milestonesview, create, edit, delete
Amendmentsview, create, edit, delete, approve
Renewalsview, create, edit, delete, approve
Approvalsview, submit, edit, delete, approve
Reportsview, export
Settingsview, edit

5. REST API & Webhooks

API

  1. Settings → enable REST API.
  2. Create a key under API Keys.
  3. Send header X-CLM-API-Key: your_token or Authorization: Bearer your_token.
  4. Base URL: {your-crm}/contract_lifecycle_management/clm_api

Webhooks

  • contract.stage_changed
  • contract.expiring
  • renewal.approved

Payloads are JSON with HMAC-SHA256 signature in X-CLM-Signature.

6. Cron Jobs

Background tasks run through Perfex CRM’s main cron. Example:

* * * * * php /path/to/perfex/index.php cron/index > /dev/null 2>&1

Enable related options in module Settings (expiry notify, auto-expire, milestone overdue, renewal stage move).

7. Uninstall

  1. Setup → Modules → Deactivate.
  2. Click Uninstall.
  3. All clm_* tables, clm_* options, and uploads/clm/ are removed.

Warning: Uninstall is destructive. Back up your database first. Core Perfex CRM data is not deleted.

Staff permissions (from module)

Assign under Setup → Staff → Roles. Each feature can expose different actions:

FeatureActions
CLM Dashboard
clm_dashboard
view
Contracts
clm_contracts
view, create, edit, delete, transition
Lifecycle Stages
clm_stages
view, create, edit, delete
Milestones
clm_milestones
view, create, edit, delete
Amendments
clm_amendments
view, create, edit, delete, approve
Renewals
clm_renewals
view, create, edit, delete, approve
Approvals
clm_approvals
view, create, edit, delete, approve
Reports
clm_reports
view, export
Settings
clm_settings
view, edit

Related: Quick Start · How to Install · FAQ & Tips · Version & Changelog

Did you find this article useful?