Skip to main content
The InField Quickstart deployment pack (dp:infield) is a per-location pack for configuring InField on a Cognite Data Fusion project. It creates the instance spaces, InField location configuration, access groups, and a Fusion location filter needed to run InField at a single plant or site. The pack uses CDM and IDM standard views directly — no custom data model is required — and is designed to be copied once per location to support multi-site deployments. InField is Cognite’s field execution application: field workers use it to complete tasks and capture measurements and observations with full traceability. Supervisors and planners use it to plan and assign work, build templates and checklists, and monitor operational progress. This pack handles the CDF-side configuration so the application is ready to connect to your project’s IDM-based data from day one. For an overview of the application, see About Cognite InField.

Who it’s for

Target personas:
  • Data engineers — configure and deploy InField for one or more plant or site locations.
  • Subject matter experts — maintenance and operations leads who define the InField setup.
Use this pack when:
  • You are setting up a new InField location on a CDF project that already has IDM-based asset, maintenance, and notification data.
  • You need repeatable, environment-consistent InField configuration across dev, test, and prod.
  • You are adding a second or third location to an existing InField deployment — copy the module folder once per site.
  • You want role-based access control (read-only, normal, template admin, checklist admin) wired to IdP groups from the start.
When not to use this pack:
  • If your project uses the legacy APM-based maintenance order model. InField requires cdf_idm/CogniteMaintenanceOrder/v1 — migrate to IDM before deploying.
  • If your CDF project does not yet have IDM-compatible source data (assets, maintenance orders, operations, notifications) loaded. Deploy and populate your data model first.

What’s included

The pack ships a single module, cdf_infield_location, that you copy once per location.

Prerequisites

Verify all of the following before you start:
  • Cognite Toolkit version 0.8 or later is installed. See Setting up.
  • A cdf.toml file exists in your project root. If it is missing, run cdf modules init and select Create toml file (required).
  • Authentication is configured and verified — run cdf auth init and cdf auth verify using a local .env file. See Authentication and authorization.
  • IDM-based source data is already loaded into CDF — an asset hierarchy, maintenance orders, operations, notifications, time series, and files in IDM-compatible spaces. InField requires cdf_idm/CogniteMaintenanceOrder/v1.
  • Four IdP group source IDs from your identity team — one each for read-only users, normal users, template admins, and checklist admins. Set these as environment variables before running cdf deploy.

Install and deploy

You can add the InField location module to an existing Toolkit project or start a new project from scratch.
Add the InField module from your project directory:
The Toolkit creates the module under modules/solutions/cdf_infield/cdf_infield_location/ and updates your config.<env>.yaml files. Before building, add the four IdP group source IDs to your project .env file (next to cdf.toml):
Open config.dev.yaml and set at minimum location, location_name, and the location description — see Configuration reference. Then build and deploy:
1

Build deployment artifacts

The Toolkit substitutes template variables and writes artifacts to the build/ directory. If you need to change the project name or any variables marked <change_me>, edit config.<env>.yaml first — see Configure, build, and deploy modules.
2

Dry-run the deployment

Inspect the output and confirm that configurations look correct before deploying.
3

Deploy to CDF

The Toolkit deploys only configurations that have changed since the last run.
4

Set up CI/CD (optional)

For governed production deployments, automate build, dry-run, and deploy in a pipeline. See Set up CI/CD pipelines.

Configure InField in the user interface

The Toolkit deploys the location configuration with default view mappings, but you confirm and complete the following in the InField application — view mappings and the asset explorer are set in the UI. Open InField and go to Settings (⚙). For full details on these settings, see Configure data models for InField.
1

Add the location

Go to Settings > Add location and enter the location name, description, and location code.
2

Configure view mappings

Under the location settings, set the view mappings:
  • Asset views — your CDM or IDM asset view (default: cdf_cdm / CogniteAsset / v1).
  • Activities and operations — default: cdf_idm / CogniteOperation / v1.
  • Notifications — default: cdf_idm / CogniteNotification / v1.
  • Maintenance orders — must be cdf_idm / CogniteMaintenanceOrder / v1; APM-based models are not supported.
3

Select instance spaces

Set the Customer instance space to your source data space (for example, sp_infield_{{location}}_assets) and the InField instance space to the app data space (sp_infield_{{location}}_app_inst).
4

Configure the asset explorer

Set the asset hierarchy root, display fields, and associated time series under the asset explorer settings for the location.

Verify the deployment

After deploying and completing the manual location setup, confirm success with these checks:
  1. The cdf deploy command finishes without errors and reports successful deployment of spaces and groups.
  2. In CDF, navigate to Data Modeling > Spaces and verify that all six location spaces exist: sp_infield_{{location}}_app_inst, sp_infield_{{location}}_cfg_inst, sp_infield_{{location}}_assets, sp_infield_{{location}}_maintenance, sp_infield_{{location}}_timeseries, and sp_infield_{{location}}_files.
  3. Navigate to Access management > Groups and verify that all four InField groups exist and are bound to the correct IdP source IDs.
  4. Open the InField application and confirm that the configured location appears in the location list.
  5. Use the InField search to look up assets, work orders, and notifications. Results should return data from the correct instance spaces.
  6. Verify role-based access by signing in with a user from each group and confirming the expected permissions apply — read-only users cannot edit, and template admins can manage templates.
The deployment is successful when all six spaces exist, all four groups are active, the InField location is visible and navigable, and search returns data.

Configuration reference

Parameters are set in config.dev.yaml at the project root, and IdP source IDs are set in the project .env file. Default values work for an initial single-location test deployment. Each parameter takes its default unless you override it. The defaults are demo placeholders (springfield) — replace them with your own location before deploying to a real site.

IdP source IDs

Set these in the project .env file — all four are required. They are injected at deploy time via the Toolkit’s ${VAR} substitution, so credentials stay out of source control. These are object IDs, not secrets.
To deploy a second location, copy the cdf_infield_location folder, give it a unique name (for example, cdf_infield_location_oslo), update the id in its module.toml, register it in modules/packages.toml, and provide a separate set of IdP source IDs. Each copy deploys fully independently.

Architecture

The pack deploys a single module (cdf_infield_location) that creates all CDF-side resources for one InField location. There is no custom data model — InField reads directly from CDM and IDM standard views. The module is intentionally scoped to one location so that multiple sites remain independent: a failure or reconfiguration in one location does not affect others.

Instance spaces

Default view mappings

If your project uses extended views (for example, a custom ExtendedMaintenanceOrder view in a project space), update the viewMappings section of infield_location.InFieldCDMLocationConfig.yaml before deploying.

Access groups

Key design decisions

One module per location. Each location is a fully independent copy of cdf_infield_location with its own spaces and groups. This avoids shared-state conflicts between sites and lets each location be deployed, updated, or rolled back independently. No custom data model. InField reads directly from CDM (cdf_cdm) and IDM (cdf_idm) standard views. The pack configures which views InField uses and where data lives — it does not define a schema. Project-specific extended views can be substituted via viewMappings without changing the module structure. Maintenance, operations, and notifications share one space. The sp_infield_{{location}}_maintenance space holds all three entity types. This is a hard requirement from InField: the data filters for maintenance orders, operations, and notifications must point to the same instance space. IdP source IDs via environment variables. Group source IDs are never stored in YAML — they are injected at deploy time via the Toolkit’s ${VAR} substitution from the project .env file. This keeps IdP credentials out of source control and makes the same module YAML reusable across environments.

Troubleshooting

For issues not covered here, contact Cognite support.

Support

Last modified on July 6, 2026