newTagName

The "newTagName" property specifies the unique name of a tag that is created by a transform step.  

  • It cannot be the empty string "".
  • It is required when a transform step in the "createIntegrationTable" or "alterIntegrationTable" actions includes the "tagProvenance" property and one of its objects has "provenanceAction" set to "calculateNew".
  • It is included in the response to "describeTags", "alterTag", and "createTag" when the "includeTagProvenance" property is true and one of the "tagProvenance" objects has "provenanceAction" set to "calculateNew".

"tagProvenance" example in the response to "describeTags"

   "tagProvenance": [
     {
       "provenanceAction": "collect",
       "connectorName": "INPUT: PLC 74 & Modbus",
       "connectorId": 51,
       "targetRecordPath": "source_payload.tmp",
       "description": "Collect provenance steps come from input connectors."
     },
     {
       "provenanceAction": "calculateNew",
       "newTagName": "Temperature Fahrenheit",
       "sourceRecordPaths": [
         "source_payload.temperatures.celcius"
       ],
       "targetRecordPath": "source_payload.temperatures.fahrenheit",
       "description": "Provenance steps come from the javascript transform step."
     },
     {
       "provenanceAction": "deliver",
       "connectorName": "OUTPUT: PLC 74 & Modbus",
       "connectorId": 52,
       "sourceRecordPath": "source_payload.temperature",
       "description": "Deliver provenance steps come from output connectors."
     },
     {
       "provenanceAction": "deliver",
       "connectorName": "OUTPUT: MES & REST",
       "connectorId": 53,
       "sourceRecordPath": "source_payload.temperature",
       "description": "Deliver provenance steps come from output connectors."
     }
   ]

"tagProvenance" example in an integration table's "transformSteps" property

   "transformSteps": [
     {
       "transformStepName": "standardizeTemperature",
       "transformStepMethod": "javascript",
       "transformStepService": "v8TransformService",
       "codeName": "JavaScript Standardize Temperature",
       "ownerName": "admin",
       "databaseName": "faircom",
       
       "tagProvenance": [
         {
           "provenanceAction": "calculateNew",
           "newTagName": "Temperature Fahrenheit",
           "sourceRecordPaths": [
             "source_payload.temperatures.celcius"
           ],
           "targetRecordPath": "source_payload.temperatures.fahrenheit",
           "description": "Provenance steps come from the javascript transform step."
         }
       ]
       
     }
   ]