BeginSession Element (XMLA)

Uses a SOAP header in a SOAP request message to start a new session on an instance of Microsoft SQL Server Analysis Services.

Namespace urn:schemas-microsoft-com:xml-analysis

Syntax

<soap:Envelope xmlns:soap="https://schemas.xmlsoap.org/soap/envelope/">
   <soap:Header>
      ...
      <BeginSession
         xmlns="urn:schemas-microsoft-com:xml-analysis" />
      ...
   </soap:Header>
   <soap:Body>
      ...
   </soap:Body>
</soap:Envelope>

Element Characteristics

Characteristic

Description

Data type and length

None

Default value

None

Cardinality

0-1: Optional element that can occur once and only once.

Element Relationships

Relationship

Element

Parent elements

None

Child elements

None

Remarks

The BeginSession header element is part of a SOAP request sent to an Analysis Services instance, and explicitly starts a new session on the instance. The SOAP header returned by the SOAP response contains a Session element that identifies the new session. This new session identifier be stored and sent in subsequent SOAP requests using the Session header element.

If the BeginSession header element is not sent, a session is not explicitly started. If a session is not explicitly started, transactions on that session cannot be managed. In other words, you cannot use the following XML for Analysis (XMLA) commands: BeginTransaction, CommitTransaction, and RollbackTransaction. All XMLA methods and commands executed on an implicitly started session are considered to be atomic transactions.