Skip to content
LambogeniusDocs

BizTalk BAM Viewer

How the file is read

Which files the viewer accepts and which XML elements fill each list.

VS Code extensionlambogenius.biztalk-bam-viewerFree · MIT license

Which files are accepted

The file must be well-formed XML, and either its root element name contains bam or it contains Activity or View elements. It must contain at least one Activity or View.

The BAMDefinition format

From version 0.2.0 the viewer reads the BAMDefinition XML that bm.exe get-defxml and the BAM Excel add-in export:

  • Checkpoints: a Checkpoint whose DataType is DATETIME is a milestone; any other checkpoint is a data item, shown with its type and length, such as NVARCHAR(50).
  • References by ID: ActivityRef, CheckpointRef, AliasRef, StartRef/EndRef and ViewRef are shown as the names of the elements they point to.
  • Cubes: the measures and dimensions of a Cube appear under the view its ViewRef names (or under the only view, if there is one).
  • Durations appear with the aliases of their view, with their start and end.

Elements and attributes

Element names are matched without regard to case or namespace prefix. Attribute names are matched as written or with a capital first letter (name or Name).

ListElements readAttributes used
ActivitiesActivityname (an Activity inside a View, ActivityView or Cube is not listed as an activity)
MilestonesCheckpoint (DATETIME), BusinessMilestone, Milestonename, dataType or type, and a reference such as milestoneRef or ref
Data itemsCheckpoint (other types), BusinessData, ActivityItemname, dataType and dataLength, and a reference such as activityItemRef, dataItemRef or ref
RelationshipsRelatedActivity, ActivityRelationship, Relationshipname, and activityRef, ref or relatedActivity
ViewsViewname
View activitiesActivityViewActivityRef (shown as the activity's name), or name
Aliases and durationsAlias, ViewItem, Durationname, and CheckpointRef, StartRef or EndRef
MeasuresMeasurename, AliasRef, and AggregationFunction
DimensionsDimension, ProgressDimension, TimeDimension, DataDimension, NumericRangeDimensionname

An activity or view without a name is shown as Activity 1, View 1 and so on. Version 0.1.0 read only the BusinessMilestone, BusinessData and ActivityItem forms; update to 0.2.0 for BAMDefinition exports.

Missing items?

Elements with other names are not shown. If a list is empty although the definition has content, compare the element names in the file with this table, and report the export format on GitHub.