2.2.4.85 DataSource

  • Article

Namespace: http://www.microsoft.com/performancepoint/scorecards

The DataSource complex type specifies a connection to an external data provider.

 <xs:complexType name="DataSource" xmlns:xs="http://www.w3.org/2001/XMLSchema">
   <xs:complexContent mixed="false">
     <xs:extension base="tns:FirstClassElement">
       <xs:sequence>
         <xs:element minOccurs="0" maxOccurs="1" name="CustomData" type="xs:string"/>
         <xs:element minOccurs="0" maxOccurs="1" name="CustomTimeIntelligenceSettings" type="xs:string"/>
         <xs:element minOccurs="0" maxOccurs="1" name="DataTableMapping" type="tns:DataTableMapping"/>
       </xs:sequence>
       <xs:attribute name="SourceName" type="xs:string"/>
       <xs:attribute name="ServerName" type="xs:string"/>
       <xs:attribute name="DatabaseName" type="xs:string"/>
       <xs:attribute name="CubeName" type="xs:string"/>
       <xs:attribute name="CubeDisplayName" type="xs:string"/>
       <xs:attribute name="FormattingDimensionName" type="xs:string"/>
       <xs:attribute name="FormattingDimensionDisplayName" type="xs:string"/>
       <xs:attribute name="FormattingDimensionType" type="tns:DimensionTypeEnum" use="required"/>
       <xs:attribute name="ConnectionString" type="xs:string"/>
       <xs:attribute name="Roles" type="xs:string"/>
       <xs:attribute name="UseConnectionString" type="xs:boolean" use="required"/>
       <xs:attribute name="ConnectionContext" type="tns:ConnectionContext" use="required"/>
       <xs:attribute name="PassUserNameAsAdomdCustomData" type="xs:boolean" use="required"/>
       <xs:attribute name="ReadOnly" type="xs:boolean" use="required"/>
       <xs:attribute name="MinutesToCache" type="xs:int" use="required"/>
       <xs:attribute name="ServerMajorVersion" type="xs:int" use="required"/>
       <xs:attribute name="SubTypeId" type="xs:string"/>
       <xs:attribute name="TargetApplicationId" type="xs:string"/>
     </xs:extension>
   </xs:complexContent>
 </xs:complexType>

CustomData: String of custom data for the data source (1). This element MUST be present.

For ExcelServicesWorkbook data sources, CustomData MUST contain an ExcelServicesData complex type object (section 2.2.4.97) serialized as an XML document and XML encoded.

For ExcelWorkbook data sources, CustomData MUST contain an ExcelDataSet complex type object (section 2.2.4.96) serialized as an XML document and XML encoded.

For all other data source types, CustomData MUST be an empty string.

CustomTimeIntelligenceSettings: Contains a string of custom time intelligence data for the data source. This element MUST be present.

For ADOMD.NET data sources, CustomTimeIntelligenceSettings MUST be a TimeIntelligenceMdxSettings complex type object (section 2.2.4.175) serialized as an XML document and XML encoded.

For all other data source types, this element MUST be an empty string.

DataTableMapping: Specifies how tabular data is mapped to multidimensional data for table-based data sources. This element MUST be present. This element is used for ExcelServicesWorkbook, ExcelWorkbook, SqlTabularDataSource, and SpListDataSource types. For other data source types, it MUST be set to NULL and MUST be ignored by the protocol server (2).

SourceName: Specifies the type of the data source. This attribute MUST be present and MUST be one of the values specified in the following table.

Value

Meaning

ADOMD.NET

An Analysis Services data source.

SqlTabularDataSource

A SQL Server table data source.

ExcelServicesWorkbook

An Excel Services workbook.

ExcelWorkbook

An embedded Excel workbook.

SpListDataSource

A list data source<14>.

ServerName: Specifies the name of the server (2) used by the data source. This attribute MUST be present. The content of ServerName is determined by the type of the data source as specified in the following table.

 Type

Contents

ADOMD.NET

ServerName MUST be the host name of the server (2) running Analysis Services.

SqlTabularDataSource

ServerName MUST be the host name of the server (2) instance that hosts the tabular data source.

ExcelServicesWorkbook

ServerName MUST be the URL of the site (2) which hosts the data source.

ExcelWorkbook

ServerName MUST be an empty string.

SpListDataSource

ServerName MUST be the URL of the site (2) containing the list (1) used by the data source.

DatabaseName: Specifies the name of the database used by the data source. This attribute MUST be present. The content of DatabaseName is determined by the type of the data source as designated in the following table.

Type

Contents

ADOMD.NET

DatabaseName MUST be the name of the multidimensional database used by the data source.

SqlTabularDataSource

DatabaseName MUST be the name of the database used by the data source.

ExcelServicesWorkbook

DatabaseName MUST be the name of the document library containing the workbook.

ExcelWorkbook

DatabaseName MUST be an empty string.

SpListDataSource

DatabaseName MUST be the name of the site (2) list which contains the list (1) used by the data source.

CubeName: Specifies the name of the cube used by the data source. This attribute MUST be present. The content of CubeName is determined by the type of the data source as designated in the following table.

Type

Contents

ADOMD.NET

CubeName MUST be the name of the cube used by the data source.

SqlTabularDataSource

CubeName MUST be the name of the table in the database used by the data source. CubeName MUST be in the form [schema].[table], where schema is the name of the table schema and table is the name of the table.

ExcelServicesWorkbook

CubeName MUST be the path and file name of the Excel Services workbook to be used.

ExcelWorkbook

CubeName MUST be an empty string.

SpListDataSource

CubeName MUST be the GUID of the list (1) used as the data source.

 

CubeDisplayName: Provides a display name for the CubeName used by the data source. This attribute MUST be present. The content of CubeDisplayName is determined by the type of the data source as designated in the following table.

Type

Contents

ADOMD.NET

CubeDisplayName is the name of the selected cube that is displayed to the user.

SqlTabularDataSource

CubeDisplayName is the name of the selected SQL table that is displayed to the user.

ExcelServicesWorkbook

CubeDisplayName is the name of the selected Excel Services workbook that is displayed to the user.

ExcelWorkbook

CubeDisplayName MUST be an empty string.

SpListDataSource

CubeDisplayName SHOULD be the name of the list (1).

FormattingDimensionName: Specifies the initial value for the dimension in the cube which contains the numerical formats for analytic grids or charts using the data source. This element is only used for ADOMD.NET data sources. It MUST be present for all data source types.

For non-ADOMD.NET data sources, this attribute MUST be an empty string.

For ADOMD.NET data sources, this attribute MAY be an empty string.

FormattingDimensionDisplayName: Provides a display name for the FormattingDimensionName used for ADOMD.NET data sources. This attribute MUST be present for all data source types. For non-ADOMD.NET data sources, this element MUST be an empty string.

FormattingDimensionType: Specifies the DimensionTypeEnum simple type (section 2.2.5.13) of the dimension used in FormattingDimensionName. This attribute MUST be present for all data source types. For non-ADOMD.NET data sources, this element MUST be set to "Other".

ConnectionString: Specifies the user-defined connection string used to connect to the data source when UseConnectionString is set to TRUE. This attribute MUST be present and MUST NOT be an empty string. The content of ConnectionString is determined by the type of the data source as designated in the following table.

Type

Contents

ADOMD.NET

ConnectionString MUST be a valid connection string which connects to the OLAP data source. If the ReadOnly attribute is set to "true", ConnectionString MUST be an empty string.

SqlTabularDataSource

ConnectionString MUST be a valid SQL table connection string. If the ReadOnly attribute is set to "true", the ConnectionString MUST be empty.

ExcelServicesWorkbook

ConnectionString MUST be an empty string.

ExcelWorkbook

ConnectionString MUST be an empty string.

SpListDataSource

ConnectionString MUST be an empty string.

Roles: Specifies the database roles used when connecting to an ADOMD.NET data source. This attribute MUST be present for all data source types. For non-ADOMD.NET data sources, this attribute MUST be an empty string.

UseConnectionString: If TRUE, ConnectionString is used to connect to the data source. If FALSE, the contents of the ConnectionString property are ignored and the connection string is built internally. This attribute MUST be present, and is only used for ADOMD.NET and SqlTabularDataSource data source types.

ConnectionContext: Specifies the user ConnectionContext simple type (section 2.2.5.10) to be used for authentication to the data source. This attribute MUST be present, and MUST be ignored for ExcelWorkbook data source types.

PassUserNameAsAdomdCustomData: Specifies whether to pass the user name to ADOMD.NET as part of the CustomData property of the connection string. CustomData is sometimes used as an alternative identity, distinct from the connection identity. This attribute MUST be present, is only used by ADOMD.NET data sources and MUST be ignored by all other data source types.

ReadOnly: This attribute MUST be present and MUST be set to TRUE if the data source object is read-only for the current user; otherwise, this attribute is FALSE. When calling the CreateDataSource operation (section 3.1.4.3), if this attribute is set to TRUE, the server (2) responds with a SOAP fault containing the ErrorCode "CannotPublishReadOnlyElement"; otherwise, if this attribute is set to FALSE, the creation is successful.

MinutesToCache: Specifies the timeout in minutes for caching data source requests. This attribute MUST be present and the value MUST be a non-negative integer. If MinutesToCache is set to zero, the data source MUST NOT be cached.

ServerMajorVersion: Indicates the major version of the data source being used. This attribute MUST be present.

SubTypeId: Specifies the subtype of the data source. This attribute MUST be present and MUST be the same value as the SourceName element.

TargetApplicationId: Specifies the Secure Store ([MS-SSWPS]) target application identifier containing the credentials that MUST be used for authentication to the data source when ConnectionContext is set to SecureStoreCredentials. When ConnectionContext IS NOT set to SecureStoreCredentials, this attribute MUST be ignored. This attribute MUST be present.