Configuring the Infield QS Deployment Pack with the Toolkit

The InField QS Deployment Pack helps you configure the InField application for your project by providing the required data model, environment setup, and standard configuration aligned with InField 2.0 best practices This guide walks you through the purpose of InField, prerequisites, configuration steps, data-model setup, and how to deploy your InField QS module using the Cognite Toolkit!-->

What is InField?

InField is Cognite’s Industrial application for field execution and workforce coordination. It replaces paper-based data gathering and manual reporting with a structured, digital workflow.

For field workers

Use InField to:

• View and execute tasks
• Capture measurements, inspections, and observations
• Log field findings with traceability

For supervisors & planners

Use InField to:

• Plan, schedule, and assign work activities
• Manage locations, templates, and execution flows
• Monitor operational progress

InField relies heavily on the data model configuration in CDF. As InField QS transitions from an APM data model to a fully IDM-based model, additional care is required during deployment

Why an InField QS Deployment Pack is Needed

Configuring the InField Web App is inherently complex due to:

• Continuous updates to InField’s data model
• Dependency on IDM-based data structures
• Multi-space configuration (source, app data, APM config, user profile spaces)
• Manual steps required inside the InField UI
• Need for correct identity and group mapping from Microsoft Entra ID

The QS Deployment Pack simplifies this by providing:

• Predefined InField spaces
• Standard groups & permissions
• Pre-configured data-model structure
• Environment variables ready for location-specific customization
• Repeatable deployment steps across environments

Module Components

The InField QS Deployment Pack contains the following module groups:

1. Common Module (cdf_infield_common)

Includes:

• Admin group definitions
• Base data-model spaces
• Application configuration container

2. Location-Specific Module (cdf_infield_location)

Includes:

• Source data spaces (SAP / CMMS imports)
• InField application data per location
• Location-specific user group bindings
• View mappings

3. Supporting Modules

• IDM Data Model
• APM base model (used internally for compatibility)

Prerequisites

Before configuring InField in your Toolkit project, ensure:

CDF Application Setup: Your project must already support:

• IDM Data Model

• Assets

• Time series
• Activities, operations & notifications (IDM source)

APM-based MaintenanceOrder (Project model) is not supported by InField.

Use cdf_idm/CogniteMaintenanceOrder/v1

Make sure your Project is DMOnly

This ensures the InField Web App can fully access the IDM-based models.

Access Management Setup (Toolkit-Handled)

The Toolkit auto-creates required groups under:

modules/infield/cdf_infield_common/auth

Admin Group

applications-configuration.group.yaml

Grants InField admin rights across locations.

User Group Roles

Predefined groups:      

• infield_location_normal_users_source_id:

Optional Best Practice: Create 4 groups to segment the access for infield application

• infield_viewer_role – read-only access
• infield_normal_role – standard technician access
• infield_checklist_admin_role – checklist management
• infield_template_admin_role – template management

All groups require correct Entra ID Source IDs, provided by your identity team.

Data Modeling Space Configuration

The Deployment Pack defines all necessary spaces:

Follow the Steps to Configure Infield

Step 1: Enable External Libraries

Edit your project's cdf.toml and add:

[alpha_flags] 

external-libraries = true 

[library.cognite] 

url = "https://github.com/cognitedata/library/releases/download/latest/packages.zip" 

checksum = "sha256:795a1d303af6994cff10656057238e7634ebbe1cac1a5962a5c654038a88b078" 

This allows the Toolkit to retrieve official library packages.

Step 2 (Optional but Recommended): Enable Usage Tracking

To help improve the Deployment Pack:

cdf collect opt-in 

Step 3: Add the Module

Run:

cdf modules init .

Step 4: Select the Infield QS (NOTE: use Space bar to select module)

From the menu, select:

Modules → Accelerator → InField Quickstart (QS)

Toolkit will:

• Download the InField QS package
• Update configuration
• Add module folders to your project

Step 5: Update Configuration Variables

Open config.dev.yaml

Only a few variables must be manually updated.

1. Application Configuration Source ID

Provided by Entra ID team:

infield: modules/accelerators/infield_quickstart/config.dev.yaml

You need to manually create the app registration (service principal and client secret), then create a group and add the service principal to that group. Use the Group ID of the ApplicationConfiguration group as the source ID

2. Location Identifier

infield: modules/accelerators/infield_quickstart/config.dev.yaml first_location: <location_name>

3. Location User Group Mappings

infield_quickstart: cdf_infield_location: applicationsconfiguration_source_id: <source_id> infield_location_normal_users_source_id: <users_group_source_id>

4. Environment Setup Update project name:

environment: modules/accelerators/infield_quickstart/config.dev.yaml project: <cdf_project_name> name: dev

Step 6: Deploy the Configuration

Run in order:

cdf build --env=test
 

cdf deploy --dry-run cdf deploy

If the deployment succeeds, your CDF environment now contains:

• Spaces
• Containers
• Views
• Groups
• Permissions
• Location-level structures

Step 7: Perform Manual UI Configuration in InField

Toolkit does not automate these steps.

1. Add Location

Go to:

InField → Settings (⚙️) → + Add Location

2. Configure Location Details

• Name
• Description
• Location code (if applicable)

3. View Mappings

Set mappings for:

• Asset views
• Activities & operations
• Notifications
• Maintenance Order (use IDM view)

4. Select Spaces

Under InField Location Configuration:

• Customer Instance Space → select source data space
• InField Instance Space → select app data space

5. Asset Explorer Setup

Configure:

• Asset hierarchy
• Display fields
• Associated timeseries

Step 8: Data Loading Requirements

To complete the location setup:

1. Load Asset hierarchy → IDM
2. Load Activities & Operations → from SAP / CMMS
3. Load Notifications → IDM
4. Load Maintenance Orders → IDM CogniteMaintenanceOrder/v1

All data must be mapped to the correct location spaces.

Verification

After successful deployment & UI configuration:

Search Functionality

Use the search icon (top right) to look up:

• Assets
• Activities
• Work orders
• Notifications

InField Dashboard

You should see:

• Asset details
• Associated time series
• Maintenance Order
• Activity schedule

Support

If you encounter issues with this module or deployment, consult Cognite documentation or contact your Cognite representative.

!-->