CMiC Integration

Jump to: Terminology || Integrated Workflows || Setting Up the Integration

Overview

CMiC is a leading construction ERP and project management software used by many of the largest construction companies in the world. The financial product tracks project budgets and enables project teams to track Potential Change Items (PCIs) and commit them to the overall budget once the change is approved.

With the Clearstory & CMiC integration project teams can:

1. Eliminate data entry: Because things are automatically logged in Clearstory when a trade partner submits, there is no COR line item data entry for GC project teams. With the integration, you can push something received in Clearstory directly into a PCI line item in CMiC forever eliminating PCI data entry.

2. Financial Visibility: By making Clearstory a project requirement and telling your trade partners all CORs must be posted in Clearstory for them to be valid, you now have a shared source of truth and can confidently have a real-time view at your COR exposure. With this integration, you can instantly see what CORs you have received that are not yet in a PCI in CMiC. This allows you to quickly filter Clearstory to see if your CORs have not yet been put into your forecast without any extra work.

Terminology/Field Mapping

Integrated Workflows

To push CORs from Clearstory, the integration must first be configured by a user having either an Account Owner role or an Admin role for your office (see more on setting up the integration below). Once setup is complete, to push a COR into CMiC users must:

In CMiC, create a PCI where the COR information from Clearstory will be written
In Clearstory, go to the COR log and select one or more CORs that you want to write to push to CMiC and click the Add to CMIC button at the top of the log

The Select CMiC PCI dialog opens showing the available PCIs. Select the PCI created in Step 1 and click Next.
Fill in the required PCI details and click the Push to CMiC button to add

When the transaction is complete, the PCI number is added to the COR Log for future reference

Setting up the Integration

The CMiC integration must be set up by a Clearstory user with either an Account Owner or Admin role.

Before you begin, confirm the following:

Your CMiC environment is on version R12.
You have confirmed with CMiC (via their support ticket process) that your instance has the proper APIs enabled to support this integration.
You have determined which authentication method to use: Basic Auth or OAuth2.0 via Azure AD.
- Additional documentation on OAuth2.0 is available here.
A CMiC service account has been provisioned for Clearstory with access to the following API endpoints:

GET Endpoints:

/glrestapi/rest/v1/glcompany
/pm-rest-api/rest/1/pmproject
/cm-rest-api/rest/1/cmmast
/cm-rest-api/rest/1/cmtype
/cm-rest-api/rest/1/cmstatus
/pm-rest-api/rest/2/pmprojpartner
/pm-rest-api/rest/1/scmast
/jc-rest-api/rest/1/jcjob
/jc-rest-api/rest/1/jcjobcostcodes
/pm-rest-api/rest/1/scsched
/jc-rest-api/rest/1/jcjobcostcatcodes
/cm-rest-api/rest/1/cmdetail
/sys-rest-api/rest/1/weightmeasure

POST Endpoints:

/cm-rest-api/rest/1/cmdetail
/cm-rest-api/rest/1/cmmast

PATCH Endpoints:

/cm-rest-api/rest/1/cmdetail

5. Locate your API base URL. This will be configured during setup. (https://${hostname.com}.com/${hostdomain}/cm-rest-api/rest/1/cmdetail)

To set up the integration:

Sign in to Clearstory and click Integrations in the left navigation.
Locate the CMiC card and click Manage Integration.
On the CMiC page, click Enable CMiC Configuration.
The CMiC Settings page opens.

Complete the following:

Connection Settings
- Enter your Host Name (your CMiC server hostname or IP address, e.g. atlas-mobile.cmiccloud)
- Enter your Host Domain (your organization's domain in CMiC, e.g. cmicprod)
Authentication Method — select one:
- Basic Authentication — enter your Client ID, User ID, and Password
- OAuth 2.0 — enter your client credentials
Enabled Offices — select which Clearstory offices this configuration applies to. You can create multiple configurations if different office groups connect to different CMiC environments or companies. Click Continue.

5. Verify whether Automatic Numbering of Change Items is enabled in CMiC for your company and configure the appropriate PCI header defaults, as these settings are applied during PCI creation in Clearstory.