Configuring Link
After installing Link, the sample_appsettings.json file included in the installation package must be configured to your system's specifications.
Note: The sample_appsettings.json file is located in C:/ProgramData/Weatherford/Link.
An example Link appsettings.gateway.json file is included here for reference purposes only.
Configuring the appsettings.json File
The sample_appsettings.json file included in the Link installation package is configured by the user to indicate the target and source of the data to be published. After configuring it to your specifications, rename it to "appsettings.gateway.json" and store it in the following location:
C:/ProgramData/Weatherford/Link
Object and Members in the .json file
The .json file contains objects and members. An object type defines the members contained within the object. Each member is considered a name:value pair. Some formatting rules:
- The name of each member is enclosed in quotes and is followed by a colon and its value, for example,
"name": "MySparkPlug", - Strings need to be enclosed in quotes. Numeric values, objects, and arrays should not be enclosed in quotes, for example,
"type": "Sparkplug",and"maxQueuedMessages": 5000, - Name:value pairs and objects in the same hierarchy level must be separated by commas, for example,
"groupId": "Pad123", - All members within an object must be enclosed within curly braces {}.
- Arrays, of objects or values must be enclosed in square brackets [ ], and the array elements must be separated by commas, for example,
[ "string1, string2" ]and[ { "name": "value" }, { "name": "value" } ]
In the following example, the object ("protocol") lists six members ("type", "hostname", "port", "keepAlive", etc.), with each member followed by a colon and its respective value.
|
"protocol": { "type": "MQTT", "hostname": "10.97.19.106", "port": 1883, "keepAlive": 60, "maxQueuedMessages": 100, "clientId": "MyClientId", } |
Tag Formats
Link supports the following CygNet tag formats:
| Real-time Tag Formats | DynaCard Tag Formats |
|---|---|
|
<facilityid>:<udc> (legacy) <facilityid>.<udc> <site>.<service>::<facilityid>.<udc> |
<site>.<service>:<facilityid> (legacy) <site>.<service>::<facilityid> |
The legacy format is preserved for backwards compatibility.
Properties of the Sample_appsettings.json File
The following tables describe the properties in the sample_appsettings.json file used to configure Link. The tables are grouped by sections of the sample_appsettings.json file. See the following sections:
- Gateway Section
- Publisher Endpoint Section
- CygNet Service Endpoints (shared objects)
- CVS Endpoint (publish object)
- VHS Endpoint (publish object)
- DDS Endpoint (publish object)
More:
