Permute copies the Procore data your app is allowed to read and refreshes it on a six-hour schedule. This connector only reads data. It does not change records in Procore.
Before you start
- A Permute workspace where you can add connectors.
- Access to your company's app in the Procore Developer Portal, or someone who can create one.
- A Procore company administrator who can install apps and grant access to the projects you need.
- For live data, Procore approval for your app's production credentials.
You will create a Data Connection App: Procore's name for an app that connects data to another service. It uses a Developer Managed Service Account (DMSA), an account for the app with its own access permissions. Procore creates that account when the app is installed.
If your team already has a suitable app installed, ask its owner for the Client ID and Client Secret, confirm its project access, and continue to step 5.
1. Choose live data or test data
Procore calls its live system Production. A sandbox is a separate place for testing. Choose the same environment when installing the app and when adding it to Permute.
| Environment in Permute | Use it for | Credentials to copy |
|---|---|---|
| Production | Your company's live Procore data. | Production Client ID and Client Secret. |
| Developer Sandbox | Test data in the sandbox created for your app. | Sandbox Client ID and Client Secret. |
| Monthly Sandbox | Your company's test copy of production data. | Production Client ID and Client Secret. |
Monthly Sandbox must be enabled by your Procore administrator. Apps installed in Production appear there after Procore's next monthly refresh. Confirm the app is present before connecting. See Procore's sandbox instructions.
2. Create the Procore app
- Sign in to the Procore Developer Portal. Under My Apps, select Create a New App. Give it a recognizable name, such as Company name - Permute, and select Create.
- In the app's Configuration Builder, open Data Connector Components and select Add Components.
- Under Component Type, select both checkboxes: User Level Authentication and Service Account Authentication.
- In Permissions Builder, apply the permissions listed below, then select Save Component.
- Complete Instructions and Post-Installation Notes. You can use this page's address for the instructions link and add a note to connect the installed app in Permute.
- Select Create Version, enter a version number such as 0.1.0, and select Create. This saves the app settings as an installable version.
Permissions for importing all supported data
For the broadest data access, use the following settings in Permissions Builder. Open each tab and set every tool listed in that row to the permission shown.
| Tab | Tools | Permission to select |
|---|---|---|
| Company Level | Admin, Directory, Inspections, Portfolio, Schedules, Timecard, Timesheets | Admin |
| Project Level | Admin, Budget and Budgets (one or both may appear; select all which appear), Change Events, Change Orders, Commitments, Daily Log, Direct Costs, Directory, Incidents, Inspections, Locations, Observations, Prime Contract, Production Tracking, Punch List, RFIs, Schedule, Submittals, Tasks, Timesheets | Admin |
| Project Level | WBS Codes | Standard (Admin is unavailable) |
Leave tools not listed above at None, then select Save Component.
These settings favor broad access, including private records. Admin also allows changes in Procore; Permute's connector only reads data. Company-level Directory Admin also allows managing users and permissions across your company.
To include every project, add all your projects under Permitted Projects in step 3. Then choose Everything under Sync which data? in step 5. Permute can import supported data from the Procore tools enabled in your account.
Get Procore approval to sync real company data
Before Permute can sync your company's real Procore data, your company must get its custom app approved by Procore. Complete these steps in the Procore Developer Portal:
- Verify your organization. Follow Procore's verification and production access steps to become a verified developer. Verification is once required for the organization which owns the app.
- Request approval for your app. After verification, follow Procore's verification and production access steps, linked above, to submit the Request Production Credential Access request for this app. Wait for Procore's approval before continuing. Each app requires its own approval.
This approval is part of setup; you do not need approval for each sync. While waiting, you can test with Developer Sandbox data.
Once the app has been tested and production access is approved, open Configuration Builder, select Promote Version, add release notes, and select Promote. Then open the app's Versions tab and copy the App Version Key for installation. For Developer Sandbox, copy the Sandbox App Version Key from the same tab instead.
3. Install the app and allow project access
Your Procore company administrator completes this step in the environment chosen above.
- Open the company's Admin tool, then App Management.
- Select Install App, then Install Custom App.
- Paste the App Version Key into App Version ID. Select Install, review the details, and confirm.
- In App Management, select View beside the installed app, then open Permissions.
- Under Permitted Projects, choose the projects which Permute should read and select Add.
4. Copy the app's connection details
- Return to your app in the Developer Portal and open OAuth Credentials.
- Copy the Client ID and Client Secret for the environment in step 1. The ID identifies the app; the secret works like its password.
- Keep the secret private. Paste it only into the connector form in Permute, where it is stored encrypted.
Company ID is usually optional. If your company uses Multiple Procore Regions, which is how Procore hosts accounts in different locations, supply it so Permute can find the company. Copy the company ID from your Procore company URL, or ask your administrator for it. Use the company ID, not a project ID.
5. Add Procore in Permute
- Open your Permute workspace. Go to Connectors, select Add connector, and choose Procore.
- Enter a name which will help you recognize this connection.
- For Environment, choose Production for live company data. For testing, choose Developer Sandbox or Monthly Sandbox, depending on where your test data is stored. Paste the Client ID and Client Secret, and add the Company ID if needed.
- Under Sync which data?, choose Everything to include all available tables, or Select manually to choose the tables after connecting. A table is a set of related records, such as projects or purchase orders.
- Select Connect. If you chose manual selection, finish choosing your tables before starting the data sync.
Wait for the first sync to finish, then open the connector's View Data action. Check a known project and a few records against Procore. Confirm that the projects which you expected are present and review any sync errors.
What data can you bring in?
The connector supports the following groups. Your results depend on the Procore tools your company uses, the app's permissions, permitted projects, and the tables selected in Permute.
| Data group | Examples |
|---|---|
| Companies and projects | Company details, projects, offices, vendors, people, and project roles. |
| Budgets | Budget views, detail and summary rows, saved budget snapshots, and budget changes. |
| Contracts and costs | Prime contracts, purchase orders, subcontracts, direct costs, and owner payment applications. |
| Changes to work | Change events and supported change order stages, with related details. |
| Project reviews | Requests for information (RFIs), submittals, responses, and related attachment details. |
| Quality and safety | Inspection checklists, punch items, observations, incidents, and injuries. |
| Field activity | Manpower and work logs, timecard entries, and actual production quantities. |
| Dates and tasks | Project dates, tasks, task items, comments, and company schedule summaries. |
Attachment records contain details such as file names and links. This connector does not download or read the attached files.
How updates work
A sync reads the selected tables again and updates the saved data in Permute. Automatic syncs use a six-hour schedule. You can also use the Sync Data button on the connector to request an update.
The data represents the latest successful read, within the access and limits of each Procore tool.
If an update fails, previously synced data should remain available. Check the last successful sync and potential error messages before treating those records as current. An empty table after a successful sync means no readable records were returned; an access error does not mean that the table is empty.
Change access or credentials later
To include another project, have your administrator add it under the app's Permissions tab in Procore, then sync again.
To add tool permissions, save and install an updated app version. Recheck its permitted projects, review the selected tables in Permute, and sync again.
If the app's secret changes, use Change Credentials on the Procore connector in Permute and enter the complete connection details again.