Octave EAM Field Mapping

The asset_mapping parameter controls what the connector sends. Each entry is "praedico field": "EAM source". For what each Praedico field means, see Create or update assets in the API Reference.

Writing a mapping

Source	Example	Result
EAM field	`Equipment.DocumentID`	Copies the value.
EAM field with translation	`Equipment.Status.Code \| Installed=A, Withdrawn=I`	Copies the value and translates it.
Fixed value	`const:Octave EAM`	Always sends this value.
Empty	`""`	Doesn’t send the field.

Lists in the asset record are read by key: Description.en, Property.eam.FromPoint, and Classification.Equipment Categories.

Default mapping

Fields marked Required must have a value, or Praedico rejects the asset.

Praedico field	Default Octave EAM source
`id`Required	`Equipment.DocumentID`
`subAreaId`Required	`Equipment.DepartmentCode`
`name`Required	`Description.en`
`description`	`Description.en`
`status`Required	`Equipment.Status.Code`translates `Installed=A`
`createdBy`	Not mapped
`updatedBy`	Not mapped
`createdDate`	`Equipment.CommissionDateTime`
`updatedDate`	`ApplicationArea.CreationDateTime`
`startPoint`	`Property.eam.FromPoint`
`endPoint`	`Property.eam.ToPoint`
`shapeType`Required	`computed:shapeType`
`isComponent`	Not mapped
`assetCategoryId`Required	`Classification.Equipment Categories`
`assetTypeId`Required	`Classification.Equipment Categories`
`parentId`	Not mapped
`geolocation.linearReferenceStart`	`Description.en`
`geolocation.linearReferenceEnd`	`Description.en`
`geolocation.locationStart`	`Property.eam.FromPoint`
`geolocation.locationEnd`	`Property.eam.ToPoint`
`geolocation.locationUnit`	Not mapped
`geolocation.offsetStart`	Not mapped
`geolocation.offsetEnd`	Not mapped
`geolocation.offsetUnit`	Not mapped
`geolocation.latitudeStart`	Not mapped
`geolocation.latitudeEnd`	Not mapped
`geolocation.longitudeStart`	Not mapped
`geolocation.longitudeEnd`	Not mapped
`geolocation.coordinateXStart`	Not mapped
`geolocation.coordinateXEnd`	Not mapped
`geolocation.coordinateYStart`	Not mapped
`geolocation.coordinateYEnd`	Not mapped
`assets`	Not mapped
`assetProperties`	Not mapped

Default mapping as JSON

{
  "id":                               "Equipment.DocumentID",
  "subAreaId":                        "Equipment.DepartmentCode",
  "name":                             "Description.en",
  "description":                      "Description.en",
  "status":                           "Equipment.Status.Code | Installed=A",
  "createdBy":                        "",
  "updatedBy":                        "",
  "createdDate":                      "Equipment.CommissionDateTime",
  "updatedDate":                      "ApplicationArea.CreationDateTime",
  "startPoint":                       "Property.eam.FromPoint",
  "endPoint":                         "Property.eam.ToPoint",
  "shapeType":                        "computed:shapeType",
  "isComponent":                      "",
  "assetCategoryId":                  "Classification.Equipment Categories",
  "assetTypeId":                      "Classification.Equipment Categories",
  "parentId":                         "",
  "geolocation.linearReferenceStart": "Description.en",
  "geolocation.linearReferenceEnd":   "Description.en",
  "geolocation.locationStart":        "Property.eam.FromPoint",
  "geolocation.locationEnd":          "Property.eam.ToPoint",
  "geolocation.locationUnit":         "",
  "geolocation.offsetStart":          "",
  "geolocation.offsetEnd":            "",
  "geolocation.offsetUnit":           "",
  "geolocation.latitudeStart":        "",
  "geolocation.latitudeEnd":          "",
  "geolocation.longitudeStart":       "",
  "geolocation.longitudeEnd":         "",
  "geolocation.coordinateXStart":     "",
  "geolocation.coordinateXEnd":       "",
  "geolocation.coordinateYStart":     "",
  "geolocation.coordinateYEnd":       "",
  "assets":                           "",
  "assetProperties":                  ""
}

Good to know

startPoint, endPoint, geolocation.locationStart, and geolocation.locationEnd must be numbers.
computed:shapeType sets Point or LineString from startPoint and endPoint. Keep it after both.
Mapping changes apply to the next asset saved in EAM.