Exporting with Metadata

Enabling the Include Metadata option while exporting files allows capturing not just the file content, but also additional details about the file and its participants . This topic includes examples of exported Microsoft Teams chat data, highlighting the differences in attributes when including or excluding metadata information.

The following table presents a comparison of the attributes for both export options:

XML Elements

XML Sub Elements

Attributes

Description

Possible Values

Export Including metadata

Regular export

Transcript info

Yes

No

sn:transcript-infos



The parent element that contains information about one or more transcripts.


Yes

No


sn:transcript-info


An element that contains information about a single transcript.


Yes

No


[transcript-info]. sn:transcript-id


The unique identifier for the transcript.


Yes

No


[transcript-info]. sn:transcript-timestamp


The date and time when the transcript was created.


Yes

No


[transcript-info]. sn:source-endpoint-id


The identifier for the endpoint where the transcript was generated.


Yes

No


[transcript-info]. sn:source-endpoint-version


The version of the endpoint where the transcript was generated.


Yes

No


[transcript-info]. sn:interaction-id


The unique identifier for the interaction that generated the transcript.


Yes

No


[transcript-info]. sn:interactionDataState


The state of the interaction data, such as whether it is valid or invalid.


Yes

No


[transcript-info]. sn:interaction-start-time


The date and time when the interaction that generated the transcript started.


Yes

No


[transcript-info]. sn:interaction-checksum


A checksum value that can be used to verify the integrity of the interaction data that generated the transcript.


Yes

No


[transcript-info]. sn:interaction-processed-time


The date and time when the transcript was processed.


Yes

No

participants



sn:participants



A container for participant information


Yes

No


sn:participant


A container for a specific participant information


Yes

No



participant-role

The role of the participant in the conversation

  • initiator

  • participant

  • caller

  • callee

  • organizer

  • presenter

  • sender

  • recipient

  • from

  • to

  • CC

  • BCC

  • poster

  • commenter

  • re-poster

  • rater

  • creator

  • assignee

  • required invitee

  • optional invitee

  • responder

  • author

  • owner

  • follower

  • subscriber

  • moderator

  • reviewer

  • updater

  • none

  • miscellaneous

  • system

Yes

No



participant-id

A unique identifier for the participant


Yes

No


[participant].sn:network-info


Information about the network






endpoint-id-type

The type of endpoint identifier for the participant

  • login

  • phone

  • email

Yes

No


[network-info]. itm-types:network


The name of the network the participant belongs to


Yes

No


[network-info]. itm-types:endpoint-id


The endpoint identifier for the participant


Yes

No


[network-info]. itm-types:display-name


The display name of the participant


Yes

No


[participant].sn:user-info


Information about the user associated with the participant


Yes

No


[user-info]. itm-types:user-id


The user ID associated with the participant


Yes

No


[user-info]. itm-types:user-type


The type of user associated with the participant (internal/external)


Yes

No


[user-info]. itm-types:name


The name of the user associated with the participant


Yes

No


[user-info]. name. itm-types: first


The first name of the user associated with the participant


Yes

No


[user-info]. name. itm-types: last


The last name of the user associated with the participant


Yes

No


[user-info]. itm-types:affiliation


The affiliation of the user associated with the participant


Yes

No


[user-info]. itm-types:geo-location


The geographical location of the user associated with the participant


Yes

No


[user-info]. itm-types:phone-numbers


The phone numbers associated with the user associated with the participant


Yes

No

metadata

Yes

Yes

sn:metadata



The parent tag for all metadata related to the conversation


Yes

No


sn:tenant-id


The identifier for the tenant associated with the conversation


Yes

Yes


sn:cluster-id


The identifier for the cluster associated with the conversation


Yes

Yes


itm-types:time-frame


A container for the start and end times of the conversation


Yes

Yes


[time-frame].itm-types:start-time

timestamp

The timestamp for the start of the conversation


Yes

Yes


[time-frame].itm-types:end-time

timestamp

The timestamp for the end of the conversation


Yes

Yes


sn:global-communcation-oid


The unique identifier for the conversation


Yes

Yes


sn:global-parent-communication-oid


The unique identifier for the parent conversation


Yes

No


sn:global-thread-oid


The unique identifier for the conversation thread


Yes

No


itm-types:modality

classification

The classification of the modality

  • uc

  • email

  • collaboration

  • social

  • file archive

Yes

No



type

The type of the modality

  • public

  • private

  • federated

Yes

No


[modality].itm-types:channel


The channel used for the conversation


Yes

No


[modality].itm-types:network


The network used for the conversation


Yes

No


itm-types:subject


The subject of the conversation


Yes

No



content-type

The content type of the subject


Yes

No


itm-types:groups


A container for the groups associated with the conversation


Yes

No


[groups].itm-types:group


The name of the group


Yes

No


itm:attributes


A container for any additional attributes related to the conversation


Yes

No


[attributes].itm-types:attribute

user-visible

Whether or not the attribute is visible to the user


Yes

No



name

The name of the attribute


Yes

No



indexable

Whether or not the attribute is indexable


Yes

No



content-type

The content type of the attribute


Yes

No




The value of the attribute


Yes

No

demographic





Yes

No

sn:demographic



An element that contains demographic information.


Yes

No


sn:divisions


An element that contains information about a geographic division.


Yes

No


[divisions]. sn:division


The name of the geographic division.


Yes

No

text-events





Yes

Yes

sn:text-events



An element that contains information about text events.


Yes

Yes


sn:text-event


An element that contains information on a specific text event.


Yes

Yes



text-event-id

A unique identifier for the text event.


Yes

Yes



action

The type of action performed on the text object, e.g., "create," "update," "delete."


Yes

Yes



history-flag

The flag is used when a contextual or historical text event is included outside the interaction’s time frame.





[text-event]. itm:text-object


An element that contains the text object associated with the text event.


Yes

Yes


[text-event]. [text-object].itm:text-object-id


A unique identifier for the text object.
Parent text object identifier for MS Teams replies within a day.


Yes

Yes


[text-event].[text-object].itm:system-flag


A flag indicating whether the text object is a system object.


Yes

Yes


[text-event]. [text-object].itm:text-object-style


The style of the text object.

  • normal message

  • disclaimer message

  • notice message

  • warning message

  • file transfer message

  • participant join message

  • participant leave message

  • form message

  • admin action message

  • audio

  • video

  • meeting

  • header

  • body

  • posting

  • comment

  • share

  • subscribe

  • add to

  • like

  • dislike

  • task

  • calendar event

  • poll posting

  • poll response

  • profile

  • attached text

  • other

Yes

Yes


[text-event].[text-object].itm:event-time


The time the text event occurred.


Yes

Yes



description,







timestamp






[text-event].[text-object].itm:participant-id


The identifier of the participant who created the text object.


Yes

Yes


[text-event].[text-object].itm:file-event-ids


Unique identifier for the file object


No

Yes



file-event-id

Unique identifier for the file event


No

Yes


[text-event].[text-object].itm:text-content


The actual text content of the text object.


Yes

Yes



user-visible







indexable







content-type


  • text/plain

  • text/html

  • text/xml

  • text/rtf




[text-event].[text-object]. itm:attributes


A placeholder for any additional attributes of the text object.


Yes

Yes


[text-event].sn:creator-participant-id


The identifier of the participant who created the text event.


Yes

Yes


[text-event].sn:create-time


The time the text event was created.


Yes

Yes


[text-event].sn:interaction-checksum


The checksum of the interaction associated with the text event.


Yes

Yes


[text-event].sn:snapshot-time


The time a snapshot of the text object was taken.


Yes

Yes


[text-event].sn:process-time


The time the text event was processed.


Yes

Yes

file-events





Yes

No

sn:file-events



Root element for file events


Yes

No


sn:file-event








action

Type of file event, e.g. create, modify, delete


Yes

No



file-event-type

Type of file event, e.g. inline, reference

  • inline

  • attachment

  • raw

Yes

No



file-event-id

Unique identifier for the file event


Yes

No



history-flag

The flag is used when a contextual or history file event is included outside the interaction’s time frame.





[file-event].itm:file-object


Contains information about the file


Yes

No


[file-event].[file-object] .itm:file-object-id


Unique identifier for the file object


Yes

No


[file-event].[file-object].itm:event-time


Description of the event time


Yes

No



description

Description of the timestamp






timestamp

Timestamp of the file event in ISO 8601 format


Yes

No


[file-event].[file-object].itm:participant-id


Unique identifier for the participant


Yes

No


[file-event].[file-object].itm:file-content




Yes

No



user-visible

Whether the file is visible to the user or hidden






name

Name of the file


Yes

No



indexable

Whether the file is indexable or not


Yes

No



content-type

MIME type of the file content


Yes

No



encoding

Encoding of the file content, e.g. base64


Yes

No


[file-event].[file-object].itm:attributes


Contains metadata attributes for the file


Yes

No


[file-event].[file-object].[attributes]. itm-types:attribute








user-visible

Whether the attribute is visible to the user or hidden


Yes

No



name

Name of the attribute


Yes

No



indexable

Whether the attribute is indexable or not


Yes

No



content-type

MIME type of the attribute value


Yes

No


[file-event].sn:interaction-checksum


Checksum of the interaction


Yes

No


[file-event].sn:filecontent-checksum


Checksum of the file content


Yes

No


[file-event].sn:snapshot-time


Timestamp of the snapshot in ISO 8601 format


Yes

No


[file-event].sn:process-time


Timestamp of when the file event was processed in UTC time


Yes

No

app-metadata



Note: This XML tag is exclusive for files exported from Case Management.


Yes

No

itm:app-metadata



XML element used to hold metadata about the chat message, such as whether it's on hold or has certain tags associated with it.


Yes

No


[app-metadata]. itm:hold-flag


Indicates whether the data is on hold.


Yes

No


[app-metadata].itm:tags


Contains a list of tags for the metadata.


Yes

No


[app-metadata].itm:tag-name


Contains the name of a specific tag


Yes

No