P&ID Annotation reference

​

Who it’s for

• Data engineers — deploy, configure, and tune the annotation pipeline.
• Subject matter experts — engineers who validate P&ID-to-asset annotations.

• You need to contextualize P&ID documents by linking them to assets and other files in your CDF data model.
• You want a production-ready annotation pipeline without building one from scratch.
• Your project ingests P&ID files from sources such as SharePoint and needs to match them to asset hierarchies from systems such as SAP.
• You need incremental processing — only new or updated files should be annotated on each run.

• If your P&ID documents require a fundamentally different annotation engine — this pack covers standard diagram detection and CDF annotation.
• If P&ID files have not yet been ingested into the CDF file store — the pack requires files to be present before it can annotate them.
• If you need to match time series to assets rather than annotate documents, use the CDF Entity Matching deployment pack instead.

​

What’s included

​

Prerequisites

• 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.
• P&ID files are already ingested into the CDF file store, and an asset hierarchy exists in the data model for matching.
• You have an IdP application for the function and scheduled workflow (IDP_CLIENT_ID / IDP_CLIENT_SECRET) and the IdP group source ID for the files.processing.groups access group.

​

Install and deploy

cdf modules add -d cdf_p_and_id_annotation

cdf build

cdf deploy --dry-run

cdf deploy

modules/
└── contextualization/
    └── cdf_p_and_id_annotation/

​

Verify the deployment

1. The cdf deploy command finishes without errors and reports successful deployment of Functions, Workflows, Transformations, Extraction Pipelines, RAW, the data set, and the access group.
2. In CDF, navigate to Integrate > Data Workflows and verify that the annotation workflow is listed (external ID p_and_id_annotation by default).
3. Trigger the workflow with Run (or wait for the daily trigger). Confirm that both tagging transformations complete before the annotation function, and that all tasks finish without errors.
4. Navigate to Build Solutions > Functions, open fn_dm_context_files_annotation, select View logs, and verify that files were processed without errors.
5. Navigate to Integrate > Staging (RAW) and verify that documents_tags, documents_docs, and files_state_store have been created and populated.
6. Use CDF Search in Industrial Tools to confirm annotations on P&ID documents — purple boxes link to assets, orange boxes link to files.

​

Configuration reference

​

Runtime parameters (extraction pipeline)

​

Architecture

​

Data flow

​

Annotation pipeline

1. Tagging — asset_tagging_tr and file_tagging_tr add a PID tag to qualifying assets and files. These are customizable examples that control which records the filterProperty / filterValues settings admit into matching.
2. Detection and matching — the annotation function reads new or updated files via the Sync API, detects tags in each diagram, and matches them against the configured file and asset views using each view’s searchProperty.
3. Annotation creation — matches at or above autoApprovalThreshold are approved and those at or above autoSuggestThreshold are suggested; both are written as CogniteDiagramAnnotation instances (diagrams.AssetLink for assets, diagrams.FileLink for files). Document-to-tag and document-to-document matches are also written to the documents_tags and documents_docs RAW tables.

​

Run modes

​

Resilience

​

Troubleshooting

​

Support