AVEVA Events to CONNECT agent configuration examples

The following sections provide examples for all configurations available for AVEVA Events to CONNECT.

Note: The examples in this topic are using the default port number 5590. If you selected a different port number, replace it with that value.

AVEVA Events to CONNECT agent configuration

},

{

"componentId": "EventsToCONNECTComponent1", "componentType": "EventsToCONNECT"

}

],

"Buffering": {

"bufferLocation": "C:/ProgramData/OSIsoft/Adapters/EventsToCONNECT/Buffers", "maxBufferSizeMB": 1024,

"enablePersistentBuffering": true

},

"General": { "enableDiagnostics": true, "metadataLevel": "Medium", "healthPrefix": null

}

},

"EventsToCONNECTComponent1": { "Logging": {

"logLevel": "Information", "logFileSizeLimitBytes": 34636833,

"logFileCountLimit": 31

},

"DataSource": {

"endpoint": "https://RESTAPIDataSourceEndpoint/api/", "healthController": "HealthCheck", "failedRequestsController": "FailedRequests", "apiKey": null,

"clientId": "<<Client Id>>", "clientSecret": "<<Client Secret>>", "tokenEndpoint": "<<Token Endpoint>>", "tokenAudience": "<<Token Audience>>", "scopes": [

"read"

],

"validateEndpointCertificate": true, "requestInterval": "1:00:00",

"utc": true,

"dataCollectionMode": "CurrentWithBackfill", "streamIdPrefix": "MyStreamIdPrefix", "defaultStreamIdPattern": "{SourceId}"

},

"DataSelection": [

{

"resourceId": "AssetTypesCreate", "queryId": "1",

"type": "AssetTypes", "action": "Create",

"messageTypeField": "messageHeaders.messageType", "messageTypeIdField": "messageHeaders.typeId", "messageActionField": "messageHeaders.action",

"messageContinuationTokenField": "messageHeaders.continuationToken",

"messageValueField": "messageBody", "selected": true,

"name": "Asset Types Creation",

"streamId": "AssetTypesController.MyQuery.MESData",

},

{

"resourceId": "AssetsUpdate", "queryId": "1",

"scheduleId": "1",

"type": "Assets",

"action": "Patch",

"messageTypeField": "messageHeaders.messageType", "messageTypeIdField": "messageHeaders.typeId", "messageActionField": "messageHeaders.action",

"messageContinuationTokenField": "messageHeaders.continuationToken", "messageValueField": "messageBody",

"selected": true,

"name": "Assets Creation",

"streamId": "AssetsController.MyQuery.MESData",

},

{

"resourceId": "EnumCreate", "queryId": "1",

"type": "Enumerations", "action": "Create",

"messageTypeField": "messageHeaders.messageType", "messageTypeIdField": "messageHeaders.typeId", "messageActionField": "messageHeaders.action",

"messageContinuationTokenField": "messageHeaders.continuationToken", "messageValueField": "messageBody",

"selected": true, "name": "Enum Creation",

"streamId": "EnumController.MyQuery.MESData",

},

{

"resourceId": "ReferenceTypeCreate", "queryId": "1",

"type": "ReferenceDataTypes", "action": "Create",

"messageTypeField": "messageHeaders.messageType", "messageTypeIdField": "messageHeaders.typeId", "messageActionField": "messageHeaders.action",

"messageContinuationTokenField": "messageHeaders.continuationToken", "messageValueField": "messageBody",

"selected": true,

"name": "Reference Type Creation",

"streamId": "ReferenceTypeController.MyQuery.MESData",

},

{

"resourceId": "EventTypeCreate", "queryId": "1",

"type": "EventTypes",

"action": "Create",

"messageTypeField": "messageHeaders.messageType", "messageTypeIdField": "messageHeaders.typeId", "messageActionField": "messageHeaders.action",

"messageContinuationTokenField": "messageHeaders.continuationToken", "messageValueField": "messageBody",

"selected": true,

"name": "Event Type Creation",

"streamId": "EventTypeController.MyQuery.MESData",

},

{

"resourceId": "ReferenceDataCreate", "queryId": "ReferenceDataTypeIdQuery1", "scheduleId": "1",

"type": "ReferenceData", "action": "Create",

"messageTypeField": "messageHeaders.messageType", "messageTypeIdField": "messageHeaders.typeId", "messageActionField": "messageHeaders.action",

"messageContinuationTokenField": "messageHeaders.continuationToken", "messageValueField": "messageBody",

"selected": true,

"name": "Reference Data Creation",

"streamId": "ReferenceDataController.MyQuery.MESData",

},

{

"resourceId": "EventDataCreate", "queryId": "EventsTypeIdQueryWithSTandET", "scheduleId": "1",

"type": "Events",

"action": "Create",

"messageTypeField": "messageHeaders.messageType", "messageTypeIdField": "messageHeaders.typeId", "messageActionField": "messageHeaders.action",

"messageContinuationTokenField": "messageHeaders.continuationToken", "messageValueField": "messageBody",

"selected": true,

"name": "Event Data Creation",

"streamId": "EventDataController.MyQuery.MESData",

},

{

"resourceId": "EventDataDelete", "queryId": "DeleteEventsTypeIdQuery1", "scheduleId": "1",

"type": "Events",

"action": "Delete",

"messageTypeField": "messageHeaders.messageType", "messageTypeIdField": "messageHeaders.typeId", "messageActionField": "messageHeaders.action",

"messageContinuationTokenField": "messageHeaders.continuationToken", "messageValueField": "messageBody",

"selected": true,

"name": "Event Data Deletion",

"streamId": "EventDataDeleteController.MyQuery.MESData",

}

],

"Schedules": [

{

"id": "1",

"period": "0:05:00",

"offset": "0:00:00"

}

],

"Resources": [

{

"resourceId": "EnumCreate",

"resourcePath": "FetchData/Enumerations/Create"

},

{

"resourceId": "EventTypeCreate",

"resourcePath": "FetchData/EventTypes/Create"

},

{

"resourceId": "ReferenceTypeCreate",

"resourcePath": "FetchData/ReferenceDataTypes/Create"

},

{

"resourceId": "AssetTypesCreate",

"resourcePath": "FetchData/AssetTypes/Create"

},

{

"resourceId": "AssetsUpdate",

"resourcePath": "FetchData/Assets/Patch"

},

{

"resourceId": "ReferenceDataCreate",

"resourcePath": "FetchData/ReferenceData/Create"

},

{

"resourceId": "EventDataCreate",

"resourcePath": "FetchData/Events/Create"

},

{

"resourceId": "EventDataDelete",

"resourcePath": "FetchData/Events/Delete"

}

],

"Queries": [

{

"queryId": "1",

"queryString": "/"

},

{

"queryId": "ReferenceDataTypeIdQuery1",

"queryString": "?typeId=SampleReferenceDataType1535126"

},

{

"queryId": "EventsTypeIdQueryWithSTandET",

"queryString": "?typeId=SampleEventType1304944&eventStartTimeFilter=?ST? &eventEndTimeFilter=?ET?"

},

{

"queryId": "EventsTypeIdQueryAllRecords", "queryString": "?typeId=SampleEventType1304944"

},

{

"queryId": "DeleteEventsTypeIdQuery1",

"queryString": "?

typeId=SampleEventType1304944&eventStartTimeFilter=05/31/2023 07:57:00"

}

]

}

}