PF-1421 - ObservationReportExporter now works with AQTS 2021.2

AQTS 2021.2 has Tag.ValueType.Text but the SDK expects Tag.ValueTypeString

Added some version-specific API logic

Author: Doug Schmidt

Samples/DotNetSdk/ObservationReportExporter/Exporter.cs

@@ -22,6 +22,7 @@
 using ApplyTagRequest = Aquarius.TimeSeries.Client.ServiceModels.Acquisition.ApplyTagRequest;
 using Attachment = Aquarius.TimeSeries.Client.ServiceModels.Publish.Attachment;
 using GetTags = Aquarius.TimeSeries.Client.ServiceModels.Provisioning.GetTags;
+using TagValueType = Aquarius.TimeSeries.Client.ServiceModels.Provisioning.TagValueType;
 
 namespace ObservationReportExporter
 {
@@ -329,10 +330,7 @@ private void ValidateTimeSeriesConfiguration()
             if (!Context.AttachmentTags.Any())
                 return;
 
-            var locationTags = TimeSeries
-                .Provisioning
-                .Get(new GetTags())
-                .Results
+            var locationTags = GetConfiguredTags()
                 .Where(t => t.AppliesToAttachments)
                 .ToDictionary(t => t.Key, t => t, StringComparer.InvariantCultureIgnoreCase);
 
@@ -351,6 +349,62 @@ private void ValidateTimeSeriesConfiguration()
             }
         }
 
+        private List<Tag> GetConfiguredTags()
+        {
+            if (TimeSeries.ServerVersion.IsLessThan(MinimumUnifiedTagsAndExtendedAttributesVersion))
+            {
+                return TimeSeries
+                    .Provisioning
+                    .Get(new GetHackTags())
+                    .Results
+                    .Select(Convert)
+                    .ToList();
+            }
+
+            return TimeSeries
+                .Provisioning
+                .Get(new GetTags())
+                .Results;
+        }
+
+        private static readonly AquariusServerVersion MinimumUnifiedTagsAndExtendedAttributesVersion = AquariusServerVersion.Create("21.3");
+
+        private static Tag Convert(HackTag hackValue)
+        {
+            return new Tag
+            {
+                Key = hackValue.Key,
+                UniqueId = hackValue.UniqueId,
+                AppliesToAttachments = hackValue.AppliesToAttachments,
+                AppliesToLocationNotes = hackValue.AppliesToLocationNotes,
+                AppliesToLocations = hackValue.AppliesToLocations,
+                AppliesToReports = hackValue.AppliesToReports,
+                AppliesToSensorsGauges = hackValue.AppliesToSensorsGauges,
+                PickListValues = hackValue.PickListValues,
+                ValueType = Convert(hackValue.ValueType),
+            };
+        }
+
+        private static TagValueType? Convert(HackTagValueType? hackValue)
+        {
+            if (!hackValue.HasValue || !SupportedTypes.TryGetValue(hackValue.Value, out var tagValue))
+                return null;
+
+            return tagValue;
+        }
+
+        private static readonly Dictionary<HackTagValueType, TagValueType> SupportedTypes =
+            new Dictionary<HackTagValueType, TagValueType>
+            {
+                { HackTagValueType.Unknown, TagValueType.Unknown },
+                { HackTagValueType.None, TagValueType.None },
+                { HackTagValueType.PickList, TagValueType.PickList },
+                { HackTagValueType.Text, TagValueType.String }, // This is reason for all this fudge code
+                { HackTagValueType.Number, TagValueType.Number },
+                { HackTagValueType.Boolean, TagValueType.Boolean },
+                { HackTagValueType.DateTime, TagValueType.DateTime }
+            };
+
         private void ExportAllLocations()
         {
             var exportedLocations = GetExportedLocations()

Samples/DotNetSdk/ObservationReportExporter/ExtraApis/TimeSeries/HackTags.cs

@@ -0,0 +1,51 @@
+using System;
+using System.Collections.Generic;
+using ServiceStack;
+
+namespace ObservationReportExporter.ExtraApis.TimeSeries
+{
+    public enum HackTagValueType
+    {
+        Unknown,
+        None,
+        PickList,
+        Text, // This changed from "Text" (before 2021.3) to "String" in 2021.3, breaking a bunch of serializations. Yuck.
+        Number,
+        Boolean,
+        DateTime,
+    }
+
+    [Route("/tags", HttpMethods.Get)]
+    public class GetHackTags
+        : IReturn<HackTagsResponse>
+    {
+    }
+
+    public class HackTagsResponse
+    {
+        public HackTagsResponse()
+        {
+            Results = new List<HackTag>();
+        }
+
+        public List<HackTag> Results { get; set; }
+    }
+
+    public class HackTag
+    {
+        public HackTag()
+        {
+            PickListValues = new List<string>();
+        }
+
+        public Guid UniqueId { get; set; }
+        public string Key { get; set; }
+        public HackTagValueType? ValueType { get; set; } // This is why all the hacked Tag DTOs are required
+        public List<string> PickListValues { get; set; }
+        public bool AppliesToAttachments { get; set; }
+        public bool AppliesToLocations { get; set; }
+        public bool AppliesToLocationNotes { get; set; }
+        public bool AppliesToReports { get; set; }
+        public bool AppliesToSensorsGauges { get; set; }
+    }
+}

Samples/DotNetSdk/ObservationReportExporter/ObservationReportExporter.csproj

@@ -239,6 +239,7 @@
   </ItemGroup>
   <ItemGroup>
     <Compile Include="ExtraApis\TimeSeries\DeleteAttachmentById.cs" />
+    <Compile Include="ExtraApis\TimeSeries\HackTags.cs" />
     <Compile Include="FilenameGenerator.cs" />
     <Compile Include="Context.cs" />
     <Compile Include="ExeHelper.cs" />