Setting up InField

info

Upon completing this guide, you should be able to open InField 2.0 at https://cognite-infield.cogniteapp.com/ on your Cognite Data Fusion project. The quickest way to get started is to use the OID example data set which is included in the cdf_demo_infield package.

Steps

Here are the basic steps to set up Infield:

1. Install and configure the CDF Toolkit as described in Getting started.
2. Verify that InField URLs are allowed in customer's firewall according to these instructions.
3. InField login enabled by Cognite (contact Cognite Support).
4. A set of groups that need to be set up in your identity provider. It is useful to have the group ids of these groups readily at hand when you set up InField (where each CDF group needs this id set as its sourceId). The groups are described below.
5. Configure, build, and deploy one of the packages cdf_demo_infield or cdf_infield (no sample data) with the tool as described in Using templates.

InField groups

Group names are suggestions only and may follow the customer's naming conventions. Each group in the identity provider is bound to a corresponding group in CDF through setting the sourceId parameter of the CDF group to the group id of group in the service provider.

Group	Purpose
cdf_tk_<dev>_readwrite_all	Programmatic access to provision and update services in dev environment, neccessary for running the toolkit
cdf_tk_<dev>_readonly_all	Programmatic access to list or read services in dev environment, useful for manually inspecting toolkit runs in the Fusion web interface
per location:
infield_<dev>_application_configuration	Users that are granted access to view the InField configuration in the build-in user interface across all locations in dev
infield_<dev>_<location>_checklist_admins	Admin users for checklists in location <location> in environment <dev>
infield_<dev>_<location>_normal_users	Normal users for checklists in location <location> in environment <dev>
infield_<dev>_<location>_template_admins	Admin users for checklists in location <location> in environment <dev>
infield_<dev>_<location>_viewers	Users who can view, but not change, checklists in location <location> in environment <dev>

About environments and locations

An environment is typically a Cognite Data Fusion project, and it is commonplace to separate between development, test and production. The environments you define are required input when running the cdf-tk tool.

The definition of locations may vary from customer to customer, but they are usually used to distinguish between different sites, plants, geographical locations or systems.

How to move from Open Industrial Data (OID) to your own data

It is recommended to deploy the default setup with the OID example data first to get a feel for how InField works. This is included in the cdf_demo_infield package. Once you are ready to move to your own data, you can choose two different paths:

1. Copy the cdf_oid_example_data module from cognite_modules into custom_modules, rename it (remove the cdf_ prefix) and then replace with your own csv files, P&IDs, etc.
2. Set up an extraction pipeline for each of the data types to feed live data into CDF. An example of such a pipeline can be found in the examples/cdf_data_pipeline_asset_valhall module.