Skip to main content
When deploying InRobot with the toolkit, all changes you make in the user interface will be overwritten by the next change in the toolkit.

​
Before you start

Make sure you have the following:
  • A Cognite project you can use to access Cognite Data Fusion.
  • A classic asset hierarchy. In Data explorer in CDF, note the External ID of the root asset; you’ll need it for your location.
  • The following groups in your source system (Azure portal):
    GroupPurpose
    Users_<Location>The users can access all InRobot functionality, such as controlling the robot, creating and running missions, etc.
    Admin_<Location>The users can access the CDF project and create assets, data models, 3D models, see functions, etc.
    Robot_1_<Location>The robot can write the robotics data, download robot-specific files, such as maps, read or access uploaded robot data, upload the collected data to CDF, etc.
    Run_Function_UserThe function that runs on images that the robot has created. The function can write labels, time series, files, data model instances, events, annotations, etc.
If you need to add more locations and robots, ensure that the groups are clearly named.
  • A 3D model of the location where the robot inspection will take place. In Data management > Data explorer > 3D, select your model and note its name; from the URL, note the model modelId and revisionId.
  • An application registered in the Azure portal. Copy and store the Application (client) ID (clientId) and the Directory (tenant) ID (tenantID) values securely.
  • A client secret. Copy and store the client secret value securely.
  • Access groups. Copy and store the Object Id of the created group securely.
  • The application added to the group.
  • Functions service activated for your project. Go to CDF > Data management > Build solutions > Functions > Activate functions. It can take up to 2 hours to activate the functions service.

​
Use toolkit

1

Install and configure the Cognite Toolkit

Install and configure the Cognite Toolkit.
2

Add URLs to your allowlist

Make sure you added URLs to your allowlist.
3

Enable sign-in to InRobot

If necessary, contact Cognite Support to enable sign-in to InRobot.
4

Configure the modules

In config.<env>.yaml, replace the <change_me> values. The config file has three modules inrobot, common, and cdf_apm_base that must be used together.See the sections below for details on each module configuration.

​
InRobot module

Set up the following InRobot variables: 
inrobot:
  first_root_asset_external_id: '<change_me>'
  inrobot_admin_first_location_source_id: <change_me>
  inrobot_users_first_location_source_id: <change_me>
  robot_1_first_location_source_id: <change_me>
  run_function_user_group_source_id: <change_me>
  run_function_client_id: <change_me>
  run_function_secret: ${<change_me>}

  robot_1_dataset_ext_id: '<change_me>'
  three_d_model_name: '<change_me>'
  three_d_type: '<change_me>' # either THREEDMODEL or POINTCLOUD
  three_d_model_id: <change_me>
  three_d_revision_id: <change_me>
Variable nameDescription
first_root_asset_external_idThe external ID for your root asset.
first_locationA human-readable name included as a part of different location-specific spaces and groups.
inrobot_admin_first_location_source_idThe ID for the admin group for the location.
inrobot_users_first_location_source_idThe ID for the user group for the location.
robot_1_first_location_source_idThe ID for the robot group for the location.
run_function_user_group_source_idThe ID for the run function group.
run_function_client_idThe run function client ID (app registration in Azure).
run_function_secretThe secret for the run function app registration. This will be stored in your .env file and should be referenced securely.
robot_1_dataset_ext_idThis is the data set for your robot. You can give this whatever value you want.
three_d_model_nameThe name of the 3D model as named in CDF.
three_d_typeThe type of 3D model, either THREEDMODEL or POINTCLOUD.
three_d_model_idThe model ID of your 3D model.
three_d_revision_idThe revision ID of your 3D model.

​
CDF APM Base module

Do not include this module if you’ve already set up InField. If you’ve included the module and run into an error, rerun the toolkit command without the cdf_apm_base module.
Set up the following data modeling configuration variables: 
cdf_apm_base:
  apm_datamodel_space: '<change_me>'
  apm_datamodel_version: '<change_me>'
Variable nameDescription
apm_datamodel_spaceThe space used for the APM data model. Most customers can use APM_SourceData.
apm_datamodel_versionThe version of the APM data model. Most customers can use 1.
To introduce a new robot or location, contact InRobot support for help. There will be toolkit support for this process in the future.

​
Common module

If you’ve created the toolkit admin groups in Azure, you can set up the following variables: 
cdf_auth_readwrite_all:
  readwrite_source_id: <change_me>
  readonly_source_id: <change_me>
Variable nameDescription
readwrite_source_idThe ID for the group that can create, edit, and delete groups, access spaces, etc., for the toolkit.
readonly_source_idThe ID for the group that can only view groups, spaces, functions, data, etc.