cognite-toolkit 0.5.97__py3-none-any.whl → 0.7.34__py3-none-any.whl

cognite_toolkit/_builtin_modules/infield/cdf_infield_second_location/module.toml

@@ -1,3 +0,0 @@
-[module]
-title = "InField Second Location"
-is_selected_by_default = false

cognite_toolkit/_builtin_modules/infield/cdf_infield_second_location/transformations/tr_asset_oid_workmate_infield_sync_assets_from_hierarchy_to_apm.Transformation.sql

@@ -1,34 +0,0 @@
---- Create All Assets without properties
---- This is necessary so we can populate the direct relations
---- in the next select statement
-select
-  cast(asset.externalId as STRING) as externalId,
-  --- We skip the remaining properties,
-  --- but need to have these columns set so we can do a UNION ALL operation with the statement below.
-  null as parent,
-  null as source,
-  null as root,
-  null as description,
-  null as title,
-  null as sourceId
-from
-  cdf_assetSubtree('{{second_root_asset_external_id}}') as asset
-
-UNION ALL
-
---- Create All Assets with properties including direct relations
-select
-  cast(asset.externalId as STRING) as externalId,
-  (case
-    when isnull(asset.parentExternalId) then null
-    else node_reference('sp_asset_{{second_location}}_source', asset.parentExternalId)
-  end) as parent,
-  cast("Asset Hierarachy" as STRING) as source,
-  node_reference('sp_asset_{{second_location}}_source', cast(rootAsset.externalId as STRING)) as root,
-  cast(asset.description as STRING) as description,
-  cast(asset.name as STRING) as title,
-  cast(asset.externalId as STRING) as sourceId
-from
-  cdf_assetSubtree('{{second_root_asset_external_id}}') as asset
-  -- Get root asset
-  inner join cdf_assetSubtree('{{second_root_asset_external_id}}') as rootAsset on asset.rootId = rootAsset.id

cognite_toolkit/_builtin_modules/infield/cdf_infield_second_location/transformations/tr_asset_oid_workmate_infield_sync_assets_from_hierarchy_to_apm.Transformation.yaml

@@ -1,24 +0,0 @@
-externalId: tr_asset_{{second_location}}_{{source_asset}}_infield_sync_assets_from_hierarchy_to_apm
-name: asset:{{second_location}}:{{source_asset}}:infield:sync_assets_from_hierarchy_to_apm
-destination:
-  view:
-    space:  cdf_core
-    externalId: Asset
-    version: 'v1'
-  instanceSpace: 'sp_asset_{{second_location}}_source'
-  type: nodes
-ignoreNullFields: true
-dataSetExternalId: ds_transformations_{{second_location}}
-isPublic: true
-conflictMode: upsert
-# Specify credentials separately like this:
-# You can also use different credentials for the running transformations than the ones you use to deploy
-authentication:
-  clientId: {{cicd_clientId}}
-  clientSecret: {{cicd_clientSecret}}
-  tokenUri: {{cicd_tokenUri}}
-  # Optional: If idP requires providing the scopes
-  cdfProjectName: {{cdfProjectName}}
-  scopes: {{cicd_scopes}}
-  # Optional: If idP requires providing the audience
-  audience: {{cicd_audience}}

cognite_toolkit/_builtin_modules/infield/cdf_infield_second_location/transformations/tr_asset_oid_workmate_infield_sync_assets_from_hierarchy_to_apm.schedule.yaml

@@ -1,3 +0,0 @@
-externalId: tr_asset_{{second_location}}_{{source_asset}}_infield_sync_assets_from_hierarchy_to_apm
-interval: '{{scheduleHourly}}'
-isPaused: false

cognite_toolkit/_builtin_modules/infield/cdf_infield_second_location/transformations/tr_workorder_oid_workmate_infield_sync_workorders_to_apm_activities.Transformation.sql

@@ -1,17 +0,0 @@
-  select
-    cast(`externalId` as STRING) as externalId,
-    cast(`description` as STRING) as description,
-    cast(`key` as STRING) as id,
-    cast(`status` as STRING) as status,
-    /* cast(`startTime` as TIMESTAMP) as startTime,
-    cast(`endTime` as TIMESTAMP) as endTime,
-    NOTE!!! The below two datas just updates all workorders to be from now 
-    and into the future. This is done for the sake of the demo data.
-    */
-    cast(current_date() as TIMESTAMP) as startTime,
-    cast(date_add(current_date(), 7) as TIMESTAMP) as endTime,
-    cast(`title` as STRING) as title,
-    '{{second_root_asset_external_id}}' as rootLocation,
-    'workmate' as source
-  from
-    `{{workorder_raw_db}}`.`{{workorder_table_name}}`;

cognite_toolkit/_builtin_modules/infield/cdf_infield_second_location/transformations/tr_workorder_oid_workmate_infield_sync_workorders_to_apm_activities.Transformation.yaml

@@ -1,25 +0,0 @@
-externalId: tr_workorder_{{second_location}}_{{source_workorder}}_infield_sync_workorders_to_apm_activities
-name: workorder:{{second_location}}:{{source_workorder}}:infield:sync_workorders_to_apm_activities
-destination:
-  dataModel:
-    space: APM_SourceData
-    externalId: APM_SourceData
-    version: "1"
-    destinationType: APM_Activity
-  instanceSpace: 'sp_asset_{{second_location}}_source'
-  type: instances
-ignoreNullFields: true
-dataSetExternalId: ds_transformations_{{second_location}}
-isPublic: true
-conflictMode: upsert
-# Specify credentials separately like this:
-# You can also use different credentials for the running transformations than the ones you use to deploy
-authentication:
-  clientId: {{cicd_clientId}}
-  clientSecret: {{cicd_clientSecret}}
-  tokenUri: {{cicd_tokenUri}}
-  # Optional: If idP requires providing the scopes
-  cdfProjectName: {{cdfProjectName}}
-  scopes: {{cicd_scopes}}
-  # Optional: If idP requires providing the audience
-  audience: {{cicd_audience}}

cognite_toolkit/_builtin_modules/infield/cdf_infield_second_location/transformations/tr_workorder_oid_workmate_infield_sync_workorders_to_apm_activities.schedule.yaml

@@ -1,3 +0,0 @@
-externalId: tr_workorder_{{second_location}}_{{source_workorder}}_infield_sync_workorders_to_apm_activities
-interval: '{{scheduleHourly}}'
-isPaused: false

cognite_toolkit/_builtin_modules/infield/default.config.yaml

@@ -1,21 +0,0 @@
-# The root asset external id should be
-# set to different values for each location,
-# but for demo purposes we are using the same value
-first_location: oid
-first_root_asset_external_id: 'WMT:VAL'
-second_location: oid2
-second_root_asset_external_id: 'WMT:VAL'
-
-scheduleHourly: "0 * * * *"
-
-# Transformation authentication
-cdf_cluster: ${CDF_CLUSTER}
-cicd_clientId: ${IDP_CLIENT_ID}
-cicd_clientSecret: ${IDP_CLIENT_SECRET}
-cicd_tokenUri: ${IDP_TOKEN_URL}
-cdfProjectName: ${CDF_PROJECT}
-# Optional: If idP requires providing the scopes
-cicd_scopes:
-  - ${IDP_SCOPES}
-# Optional: If idP requires providing the audience
-cicd_audience: ${IDP_AUDIENCE}

cognite_toolkit/_builtin_modules/inrobot/README.md

@@ -1,41 +0,0 @@
-# InRobot Module
-
-This module allows you to quickly set up an InRobot project. There are a few pre-requisites:
-
-- You must have an asset heirarchy already set up. Specifically you will need the external id of the root asset for
-  your location.
-- You must have a 3D model already uploaded in Fusion. Note its model id, its revision id, and its name.
-- You must have created 4 groups in your source system: Users*<Location>, Admin*<Location>, Robot*1*<Location>,
- Run_Function_User. The naming does not matter specifically, but you may need to add more locations and/or robots in
- the future, so it would be ideal to name the groups accordingly.
-- You must have created an app registration for the robot, and added the app registration to the robot user group. Note
-  the client id and the secret for the robot app registration.
-- You must have already activated the functions service for your project. This can be done in Fusion, and can take up
-  to 2 hours to become activated.
-
-This module is meant to be used in conjunction with the toolkit common module and the cdf_apm_base module.
-
-For now, until the next version release of toolkit, you must also enable the following toolkit feature flags:
-
-cdf features set fun-schedule --enable
-cdf features set robotics --enable
-
-## Configuration Variables
-
-Specific inrobot variables you will need to define in your config YAML file:
-
-| Variable Name                             | Description                                                                                                                  |
-|-------------------------------------------|------------------------------------------------------------------------------------------------------------------------------|
-| `first_root_asset_external_id`            | This is the asset external ID for your root asset.                                                                           |
-| `first_location`                          | A human readable name that will be included as part of different location-specific spaces and groups.                        |
-| `inrobot_admin_first_location_source_id`  | The ID for the admin group for the location.                                                                                 |
-| `inrobot_users_first_location_source_id`  | The ID for the users group for the location.                                                                                 |
-| `robot_1_first_location_source_id`        | The ID for the robot group for the location.                                                                                 |
-| `run_function_user_group_source_id`       | The ID for the run function group.                                                                                           |
-| `run_function_client_id`                  | The run function client ID (app registration in Azure).                                                                      |
-| `run_function_secret`                     | The secret for the run function app registration. This will be stored in your env file and should be referenced securely.    |
-| `robot_1_dataset_ext_id`                  | This is the data set for your robot. You can give this whatever value you want.                                              |
-| `three_d_model_name`                      | The name of the 3D model as named in Fusion.                                                                                 |
-| `three_d_type`                            | The type of 3D model. This will be either `THREEDMODEL` or `POINTCLOUD`.                                                     |
-| `three_d_model_id`                        | The model ID of your 3D model.                                                                                               |
-| `three_d_revision_id`                     | The revision ID of your 3D model.                                                                                            |

cognite_toolkit/_builtin_modules/inrobot/cdf_inrobot_common/README.md

@@ -1,53 +0,0 @@
-# cdf_inrobot_common
-
-This module contains shared configurations across multiple locations for InRobot.
-
-## Auth
-
-The module creates one group that needs one matching group in the identity provider that the CDF
-project is configured with. The group is:
-
-- Run Function User. This role is used by our functions when they need to interact with CDF, for example, to add
-  annotations to images, to create timeseries, etc. This makes reference to the robot's data set, so each new robot
-  requires a new run function user.
-
-## Data models
-
-There is one space created in this module called cognite_app_data. This is the space where user and user profile
-data is stored. We also populate the APM_Config node with our default config, including the information about the
-location. If new locations are added, this node must be updated to include the new locations.
-
-## Data sets
-
-This module creates a new data set for the robot. All the robot data in CDF will be stored in this data set. The
-external id is specified in the config.yaml file, and this data_set is referred to in many other modules. Any new
-robots must have a new data set.
-
-## Functions
-
-This module contains four (4) functions that we deploy: Contextualize Robot Data, Gauge Reading, Get IR Data from
-IR Raw, and ThreeSixty. These are functions that run every minute on files with certain labels that
-the robot uploads to CDF.
-
-Because the function itself must be stored in a dataset and we use the dataset of the robot, a new function must be
-defined for each robot in the robots.functions.yaml file. Additionally, most schedules use the robot data set id as a
-data parameters - this means that a new schedule must be created for every new robot.
-
-## Labels
-
-This module creates two labels that are needed for InRobot to work: robot_gauge and read_ir. These are scoped to
-the robot's data set. This means that new labels must be created for each additional robot.
-
-## Robotics
-
-This module creates some robotics specific resources: RobotCapability and DataPostProcessing.
-
-Currently we support the following RobotCapability resources: acoustic_video, pt_ir_video, ptz_ir, ptz_video,
-ptz, threesixty, and threesixty_video.
-
-Currently we support the following DataPostProcessing resources:
-process_threesixty, read_dial_gauge, read_digital_gauge, read_level_gauge, read_valve.
-
-If there are any of these robot capabilities you do not want, you can remove the YAML file. Note that the
-process_threesixty data post processing requires the threesixty capability to be present. Similarly,
-the various gauge data post processing options require the ptz robot capability.

cognite_toolkit/_builtin_modules/inrobot/cdf_inrobot_common/auth/run-function-user.Group.yaml

@@ -1,89 +0,0 @@
-name: "gp_Run_Function_User"
-sourceId: "{{run_function_user_group_source_id}}"
-metadata:
-  origin: "cdf-project-templates"
-capabilities:
-  - datasetsAcl:
-      actions:
-        - READ
-      scope:
-        all: {}
-  - groupsAcl:
-      actions:
-        - LIST
-      scope:
-        all: {}
-  - sessionsAcl:
-      actions:
-        - CREATE
-        - LIST
-      scope:
-        all: {}
-  - projectsAcl:
-      actions:
-        - LIST
-      scope:
-        all: {}
-  - functionsAcl:
-      actions:
-        - READ
-        - WRITE
-      scope:
-        all: {}
-  - labelsAcl:
-      actions:
-        - READ
-        - WRITE
-      scope:
-        all: {}
-  - assetsAcl:
-      actions:
-        - READ
-      scope:
-        all: {}
-  - timeSeriesAcl:
-      actions:
-        - READ
-        - WRITE
-      scope:
-        all: {}
-  - filesAcl:
-      actions:
-        - READ
-        - WRITE
-      scope:
-        all: {}
-  - visionModelAcl:
-      actions:
-        - READ
-      scope:
-        all: {}
-  - dataModelsAcl:
-      actions:
-        - READ
-      scope:
-        all: {}
-  - dataModelInstancesAcl:
-      actions:
-        - READ
-        - WRITE
-      scope:
-        all: {}
-  - eventsAcl:
-      actions:
-        - READ
-        - WRITE
-      scope:
-        datasetScope:
-          ids:
-            - "{{ robot_1_dataset_ext_id }}"
-  - roboticsAcl:
-      actions:
-        - READ
-      scope:
-        all: {}
-  - annotationsAcl:
-      actions:
-        - WRITE
-      scope:
-        all: {}

cognite_toolkit/_builtin_modules/inrobot/cdf_inrobot_common/classic/robot.Label.yaml

@@ -1,6 +0,0 @@
-- name: robot_gauge
-  externalId: robot_gauge
-  dataSetExternalId: "{{ robot_1_dataset_ext_id }}"
-- name: read_ir
-  externalId: read_ir
-  dataSetExternalId: "{{ robot_1_dataset_ext_id }}"

cognite_toolkit/_builtin_modules/inrobot/cdf_inrobot_common/data_models/cogniteAppData.space.yaml

@@ -1,3 +0,0 @@
-space: cognite_app_data
-name: cognite_app_data
-description: Space for User and User Preferences Data

cognite_toolkit/_builtin_modules/inrobot/cdf_inrobot_common/data_models/inrobotApmConfig.node.yaml

@@ -1,17 +0,0 @@
-- space: "APM_Config"
-  externalId: "default-config"
-  sources:
-    - source:
-        space: APM_Config
-        externalId: APM_Config
-        version: "1"
-        type: view
-      properties:
-        featureConfiguration:
-          rootLocationConfigurations:
-            - assetExternalId: "{{ first_root_asset_external_id }}"
-              appDataInstanceSpace: sp_{{ first_location }}_app_data
-              sourceDataInstanceSpace: sp_{{ first_location }}_source_data
-        customerDataSpaceId: APM_SourceData
-        customerDataSpaceVersion: "1"
-        name: InRobot APM App Config

cognite_toolkit/_builtin_modules/inrobot/cdf_inrobot_common/data_sets/robot_1.dataset.yaml

@@ -1,2 +0,0 @@
-- externalId: "{{ robot_1_dataset_ext_id }}"
-  name: "Robot 1 Dataset"

cognite_toolkit/_builtin_modules/inrobot/cdf_inrobot_common/default.config.yaml

@@ -1,3 +0,0 @@
-run_function_user_group_source_id: <change_me>
-run_function_client_id: <change_me>
-run_function_secret: <change_me>

cognite_toolkit/_builtin_modules/inrobot/cdf_inrobot_common/functions/fn_contextualize_robot_data/README.md

@@ -1,30 +0,0 @@
-# Contextualize robot files
-
-Function for contextualizing files that are uploaded from a robot to CDF. The function connects the file to
-the correct asset, and connects the correct time series to the file. If no time series exist, they are created.
-The function also assigns the correct action label to the file, indicating what action should be taken on the file,
-e.g., read dial gauge, read valve.
-
-List all files with metadata field `{"processed":"false"}` in input data set. If the image has an asset id in the
-"asset_id"  metadata field, check that the asset exists and add that as "assetId" to the file.
-
-If the image is a gauge reading image, check if the asset has a time series with label "GAUGE_TIME_SERIES". If it does,
-add metadata field "ts_external_id" to the image.
-If not, create the timeseries.
-
-In this case we could write metadata to the time series if we are able to read it in the gauge reader service. So the
-gauge reader would check if the TS has metadata or the file has metadata.
-
-1. If the TS has metadata, use ts metadata.
-2. If the TS does not have metadata and the file has metadata, use file metadata and write that metadata to TS.
-3. If the TS does not have metadata and the file does not have metadata complete metadata, use incomplete metadata set
-4. and read remainig metadata and write metadata to TS if successful
-
-(Assume always complete or no metadata on timeseries)
-
-With this we could instruct the user to take a very close and good picture of the gauge initially and that would work
-in some cases. Optionally, the user could take en image of the gauge, add correct metadata in the vision app and
-that metadata will be written to the timeseries.
-
-It will not be easy to change the metadata if we read wrong metadata initially. An option could be to not not write
-metadata to timeseries in case 3 (when metadata is read from image).

cognite_toolkit/_builtin_modules/inrobot/cdf_inrobot_common/functions/fn_contextualize_robot_data/__init__.py

@@ -1 +0,0 @@
-"""Contextualize robot data."""

cognite_toolkit/_builtin_modules/inrobot/cdf_inrobot_common/functions/fn_contextualize_robot_data/common/README.md

@@ -1,58 +0,0 @@
-# Shared-code folder: `common`
-
-## TL;DR
-
-> This entire folder hierarchy of `common` is copied into all functions automatically.
-
-## No, I wan't to read the long story
-
-A common use case when you deal with the deployment of multiple functions simultaneously, is that you do not want to
-replicate shared code between all the function folders. In order to accomodate this, as part of the workflow
-`function-action` this template relies on, we copy all the contents in this folder (can be specified by `common_folder`
-in the workflow files, see below) the functions we upload to Cognite Functions. If this is not specified, we check if
-`common/` exists in the root folder and if so, _**we use it automatically**_ :rocket:
-
-### Handling imports
-
-A typical setup looks like this:
-
-```bash
-├── common
-│   └── utils.py
-└── my_function
-    └── handler.py
-```
-
-The code we zip and send off to the FilesAPI will look like this:
-
-```bash
-├── common
-│   └── utils.py
-└── handler.py
-```
-
-This means your `handler.py`-file should do imports from `common/utils.py` like this:
-
-```python
-from common.utils import my_helper1, my_helper2
-import common.utils as utils  # alternative
-```
-
-## No, I want `common` to be named `snowflake_utilities`
-
-No problem mate, locate `.github/workflow` and open the following files:
-
-- `deploy-pr.yaml`
-- `deploy-push.yaml`
-
-Then, in each file, scroll down until you see:
-
-```yaml
-
-- name: Deploy and schedule ${{ matrix.function }}
-  uses: cognitedata/function-action@v2
-  with:
-    function_name: ...
-    common_folder: snowflake_utilities  # <-- add it here
-    ...
-```