Share via

2.3.4.2.37 DataConnection_Type

  • Article

Target namespace: http://schemas.microsoft.com/office/visio/2011/1/core

Referenced by: DataConnections_Type

A complex type that specifies a data connection.

Attributes:

ID: An xsd:unsignedInt ([XMLSCHEMA2] section 3.3.22) attribute that specifies the identifier of a data connection. It MUST be unique amongst all the DataConnection_Type child elements of the containing DataConnections_Type.

FileName: An xsd:string ([XMLSCHEMA2] section 3.2.1) attribute that specifies the full path of an Office data connection (ODC) file or data source file. If the type of data source specified in the ConnectionString attribute corresponds to a list or Custom add-in, the value of this attribute MUST be an empty string.

ConnectionString: An xsd:string ([XMLSCHEMA2] section 3.2.1) attribute that specifies the connection string to a data source. It MUST be a valid connection string as specified in [MS-ODBCSTR]. If the type of the data source specified in the connection string is listed in the following table, the syntax of the connection string MUST match the syntax specified in the following table. Otherwise, the DataConnection_Type MUST be ignored.

Type of data source

Syntax

OLE DB

MUST be a valid connection string as specified in [MS-ODBCSTR]

ODBC

MUST be a valid connection string as specified in [MS-ODBCSTR]

List

MUST be in the following format:

"PROVIDER=WSS;DATABASE=list URL;LIST={list GUID};viewparam"

  • list URL is the URL of a list.

  • list GUID is the GUID of the list.

  • viewparam MUST be in the format "VIEW={view GUID};", if the data source is a view of a list, where view GUID is the GUID of the view; otherwise, viewparam MUST be an empty string.

Workbook

MUST be a valid connection string as specified in [MS-ODBCSTR] and MUST contain the following key-value pairs:

"DataModule=Microsoft.Office.Visio.Server.EcsDataHandler,Microsoft.Office.Visio.Server;Data Source=workbook URL;Extended Properties='HDR=hdrvalue;';"

  • workbook URL is the URL of a workbook.

  • hdrvalue equals YES, if the first row of data is the header row;otherwise, it equals NO.

Other key-value pairs are unused and MUST be ignored.

Custom add-in

MUST be a valid connection string as specified in [MS-ODBCSTR] and MUST be in the following format:

"DataModule=class name,assembly name;Add-in key=value pairs;"

  • class name is a class name.

  • assembly name is an assembly name.

  • value pairs is a semicolon-separated set of key-value pairs specific to the add-in.

Command: An xsd:string ([XMLSCHEMA2] section 3.2.1) attribute that specifies the query in a data connection.

FriendlyName: An xsd:string ([XMLSCHEMA2] section 3.2.1) attribute that is unused and MUST be ignored.

Timeout: An xsd:unsignedInt ([XMLSCHEMA2] section 3.3.22) attribute that is unused and MUST be ignored.

AlwaysUseConnectionFile: An xsd:boolean ([XMLSCHEMA2] section 3.2.2) attribute that is unused and MUST be ignored.

The following W3C XML Schema ([XMLSCHEMA1] section 2.1) fragment specifies the contents of this complex type.

 <xsd:complexType name="DataConnection_Type">
   <xsd:attribute name="ID" type="xsd:unsignedInt" use="required"/>
   <xsd:attribute name="FileName" type="xsd:string" use="required"/>
   <xsd:attribute name="ConnectionString" type="xsd:string"/>
   <xsd:attribute name="Command" type="xsd:string"/>
   <xsd:attribute name="FriendlyName" type="xsd:string"/>
   <xsd:attribute name="Timeout" type="xsd:unsignedInt"/>
   <xsd:attribute name="AlwaysUseConnectionFile" type="xsd:boolean"/>
 </xsd:complexType>