Cognite Integration Guide

review the following guide for setting up an integration between litmus edge and cognite once the integration is set up, you can send and receive data through the cognite connector before you begin you must have access to cognite data fusion https //www cognite com/en/product/cognite data fusion industrial dataops platform step 1 collect cognite connection parameters you will need to retrieve the following parameters to configure the connection project id the project id is the unique identifier assigned to each project within cognite to get the project id sign in to cognite data fusion in the top left corner, open the environment identifier to view the list of project ids select the appropriate one to integrate with litmus edge refer to projects https //api docs cognite com/20230101/tag/projects api documentation to learn more tenant id sign in to the microsoft entra admin center https //entra microsoft com/ and navigate to identity > overview > properties see how to find your microsoft entra id https //learn microsoft com/en us/entra/fundamentals/how to find tenant to learn more client id to retrieve the client id, you will need to register the cognite account as an application in microsoft entra if you don't have the appropriate permissions to create a client id, follow up with your it department see quickstart register an application with the microsoft identity platform > register an application https //learn microsoft com/en us/entra/identity platform/quickstart register app#register an application to learn more client secret to retrieve the client secret, you will need to register the cognite account as an application in microsoft entra, and then create the client secret please note that the secret value is only visible when it is created, and not available to view after if you don't have the appropriate permissions to create a client secret, follow up with your it department see quickstart register an application with the microsoft identity platform > add a client secret https //learn microsoft com/en us/entra/identity platform/quickstart register app#add a client secret to learn more cluster a cluster is a grouping of resources within the platform to retrieve the cluster value log in to cognite data fusion navigate to data management > manage > manage access click the openid connect tab refer to the audience field the cluster value is between https // and cognitedata com for example, if the audience value is https //az eastus 1 cognitedata com, the cluster value is az eastus 1 scope the scope specifies the level of access and permissions granted to an application in the cognite platform to retrieve the scope value log in to cognite data fusion navigate to data management > manage > manage access click the openid connect tab refer to the audience field and update it as needed for the scope for example, if the audience value is https //az eastus 1 cognitedata com, the scope value can be https //az eastus 1 cognitedata com/ default follow up with your it department for further assistance step 2 add cognite connector in litmus edge follow the steps to add a connector docid\ ytswgweu6h6oeunhj5hw3 and select the cognite connector provider configure the following parameters parameter description name enter a name for the connector project id enter the value retrieved in step 1 tenant id enter the value retrieved in step 1 client id enter the value retrieved in step 1 client secret enter the value retrieved in step 1 cluster enter the value retrieved in step 1 scope enter the value retrieved in step 1 subscribe interval enter the interval (in seconds) that the connector polls for data throttling limit the maximum number of messages per second to be processed the default value is zero, which means that there is no limit persistent storage when enabled, this will cause messages to undergo a store and forward procedure messages will be stored within litmus edge when cloud providers are online queue mode select the queue mode as lifo (last in first out) or fifo (first in first out) selecting lifo means that the last data entry is processed first, and selecting fifo means the first data entry is processed first step 3 enable the connector after adding the connector, click the toggle in the connector tile to enable it if you see a failed status, you can review the connector logs docid\ beqq0sszwsv9v9rif3rhk and relevant error messages step 4 set up connection (outbound or inbound) with cognite you have the option of setting up an outbound or inbound connection set up outbound connection to set up an outbound connection, you will need to create a devicehub device and tags the tags will be used to send data to cognite step a add device step b add tags step c create outbound topics for connector you will now need to import the tags you added to the connector as topics after adding all required topics, navigate to the integration overview page and ensure the connector is not disabled and still shows a connected status step d enable topics step e verify connection in cognite you can verify the connection is successfully sending data by navigating the cognite data explorer see explore data https //docs cognite com/cdf/integration/guides/exploration/data explorer to learn more set up inbound connection you have the option of subscribing to data from cognite the data that is subscribed to is a loopback as it is first sent from litmus edge to cognite, and then back to litmus edge as time series data step a create assets and time series to set up an inbound connection, you will need to create assets and time series as needed in cognite through api see assets https //api docs cognite com/20230101/tag/assets and time series https //api docs cognite com/20230101/tag/time series to learn more once you set up assets and time series, copy the ids for the time series you will refer to the ids when configuring the remote topic names for the inbound connection to collect the time series ids log in to cognite data fusion click data explorer click the appropriate asset name to select it click the time series tab click the appropriate time series name to select it under general , click the copy icon for id step b create inbound topics for connector you will create topics for the connector that will subscribe to data from associated cognite time series ids to create inbound topics navigate to integration click the connector tile click the topics tab click the add a new subscription icon the data integration dialog box appears configure the following parameters data direction select remote to local inbound local data topic enter a topic name that will be used for subscribing to data in litmus edge remote data topic copy and paste the associated time series id collected in the previous step enable select the toggle to enable the topic click yes to add the topic from the connector tile, ensure the connector is not disabled and still shows a connected status also verify the topic shows an enabled status step c verify connection in litmus edge you have several options for verifying the connection in litmus edge when subscribing to the data, you will need to use the local data topic name configured in the previous step you can visualize the incoming data using one of the dedicated applications docid\ iipan4olp8rqznjc q8br such as grafana docid\ fyznyym 3zfiuolgo5nlt you can also view the data in the flows manager docid\ jghnqyhxbik8x2nhh5vte and analytics docid 8aloe 5 c9ubqjsw0ppcx areas of litmus edge if you are creating a flow from the flows manager docid\ jghnqyhxbik8x2nhh5vte , subscribe to the local data topic name see subscribe to topics with flows docid\ h640vah9bim5zviut0yky to learn more if you are using analytics docid 8aloe 5 c9ubqjsw0ppcx , select the datahub subscribe processor and use the local data topic name see create an analytics flow docid\ ewmyjslrbisgimpdgq82a and add processors and processor connections docid\ v37iaolfgyw 7glazjt1n to learn more