CF Connect

Connect CF Connect to KODE OS for work orders data integration

​

Overview

​

Supported Capabilities

• Collect Sensor Data
• Collect Non-Sensor Data

​

Prerequisites

• An active account in https://cf—uat.sandbox.my.salesforce.com with the appropriate access permissions.
• You will need to obtain a prod link here ⬆️
• Valid username and password credentials for CF Salesforce platform.

​

Generate API Credentials

• Go to the CF Salesforce App
• Sign in using your username and password.
• Click the settings button (⚙️) in the top navigation bar (upper right corner) and select Setup.
• Navigate to the Apps > External Client Apps > External Client App Manager tab.
• Click the New External Client App button on the right upper side.
• Enter the basic information:
• External Client App Name
• Contact Email
• API Name
• Select the Distribution State
• Under API (Enable OAuth Settings) check option Enable OAuth ✔️
• Under App Settings provide the Callback URL https://www.test.salesforce.com/oauth2/callback
• Under OAuth Scopes select your options, i.e
• Manage user data via APIs (api)
• Manage user data via Web browsers (web)
• Full access (full)
• Under Flow Enablement check options
• Enable Client Credentials Flow ✔️
• Enable Authorization Code and Credentials Flow ✔️
• Under Security check options
• Require secret for Web Server Flow ✔️
• Require secret for Refresh Token Flow ✔️
• Finally, click on Create ✔️ Steps to Obtain Credentials
• Click on the external app created in the previous step
• Select the Settings tab
• Under OAuth Settings > App Settings click on button Consumer Key and Secret After completing the steps above, your Consumer Key and Consumer Secret will be used in the next step. ⬇️

​

Configure Connector in KODE OS

1. Navigate to Data Sources in your building
2. Click API Catalog and search for CF Connect
3. Click + Add Datasource
4. Complete the three-page setup flow using the credential prerequisites for this integration

​

What Data You Get

​

Work Orders

​

Polling Schedule

• WorkOrder — Default polling: 15 minutes (min: 15 minutes, max: 1 hours)

​

Available Actions

​

Create Case

​

Example Request

{
  "title": "example-value",
  "description": "example-value",
  "location": "example-value",
  "ticketType": "example-value",
  "priority": "High"
}

​

Expected Result

• KODE OS sends the action to the external API using the configured connector credentials
• The external system returns success (typically HTTP 2xx) and processes the requested operation

​

Create Work Order

​

Example Request

{
  "title": "example-value",
  "description": "example-value",
  "caseId": "12345",
  "priority": "High",
  "serviceProvider": "12345"
}

​

Expected Result

• KODE OS sends the action to the external API using the configured connector credentials
• The external system returns success (typically HTTP 2xx) and processes the requested operation

​

Update Case

​

Example Request

{
  "title": "example-value",
  "description": "example-value"
}

​

Expected Result

• KODE OS sends the action to the external API using the configured connector credentials
• The external system returns success (typically HTTP 2xx) and processes the requested operation

​

Update Work Order

​

Example Request

{
  "title": "example-value",
  "description": "example-value"
}

​

Expected Result

• KODE OS sends the action to the external API using the configured connector credentials
• The external system returns success (typically HTTP 2xx) and processes the requested operation

​

Use Cases

• Centralize maintenance requests and work order status from facility management systems
• Create and update work orders directly from KODE OS when issues are detected
• Track maintenance KPIs including response time, completion rate, and cost

​

Troubleshooting