<connection>
(Connection)
This element contains both the definition of how to get at an external data source as well as information describing how the connection is used within the workbook. Specific constructs in a worksheet, such as OLAP formulas, QueryTables, or PivotTables make use of information in the connection to retrieve or refresh data based on default events or the user's explicit request.
Parent Elements |
---|
|
Child Elements |
Subclause |
---|---|
|
|
|
|
|
|
|
|
|
|
|
Attributes |
Description |
---|---|
|
Indicates whether the connection can be refreshed in the background (asynchronously). This flag should be intentionally ignored in specific cases. example:
The possible values for this attribute are defined by the XML Schema boolean datatype. |
|
Specifies the authentication method to be used when establishing (or re-establishing) the connection. The possible values for this attribute are defined by the ST_CredMethod simple type (§3.18.17). |
|
Indicates whether the associated workbook Deleted If a new The possible values for this attribute are defined by the XML Schema boolean datatype. |
|
Specifies the user description for this connection. The possible values for this attribute are defined by the ST_Xstring simple type (§3.18.96). |
|
Specifies The unique identifier of this connection. The possible values for this attribute are defined by the XML Schema unsignedInt datatype. |
|
Specifies the number of minutes between automatic refreshes of the connection. When this attribute is not present, the connection is not automatically refreshed. The possible values for this attribute are defined by the XML Schema unsignedInt datatype. |
|
The possible values for this attribute are defined by the XML Schema boolean datatype. |
|
For compatibility with legacy spreadsheet applications. This represents the minimum version # that is required to be able to correctly refresh the data connection. This attribute applies to connections that are used by a QueryTable. The possible values for this attribute are defined by the XML Schema unsignedByte datatype. |
|
Specifies the name of the When a The possible values for this attribute are defined by the ST_Xstring simple type (§3.18.96). |
|
The possible values for this attribute are defined by the XML Schema boolean datatype. |
|
Specifies the full path to external connection file from which this This is a benefit for data source and spreadsheetML document manageability. If the definition in the external connection file is changed (e.g., because of a database server name change), then the workbooks that made use of that connection will fail to connect with their internal connection information, and reload the new connection information from this file. This attribute is cleared by the spreadsheet application when the user manually edits the connection definition within the workbook. May be expressed in URI or system-specific file path notation. Note:
The possible values for this attribute are defined by the ST_Xstring simple type (§3.18.96). |
|
Indicates whether the spreadsheet application should always and only use the connection information in the external connection file indicated by the If Applies only to OLE DB and ODBC connections, this attribute is ignored for other types of connections. The possible values for this attribute are defined by the XML Schema boolean datatype. |
|
Specifies what the spreadsheet application should do when a connection fails. The values are as follows:
The possible values for this attribute are defined by the XML Schema unsignedInt datatype. |
|
For backward compatibility purposes, this attribute indicates the version of the spreadsheet application that last refreshed the connection. This attribute applies to connections that are used by a query table. The possible values for this attribute are defined by the XML Schema unsignedByte datatype. |
|
The possible values for this attribute are defined by the XML Schema boolean datatype. |
|
This exists for data security purposes - if no external data is saved in (or "cached") in the workbook, then current user credentials can be required every time to retrieve the relevant data, and people won't see the data the workbook author had last been using before saving the file. The possible values for this attribute are defined by the XML Schema boolean datatype. |
|
The possible values for this attribute are defined by the XML Schema boolean datatype. |
|
Identifier for Single Sign On (SSO) used for authentication between an intermediate spreadsheetML server and the external data source. Note:
The possible values for this attribute are defined by the ST_Xstring simple type (§3.18.96). |
|
Used when the external data source is file-based. When a connection to such a data source fails, the spreadsheet application attempts to connect directly to this file. May be expressed in URI or system-specific file path notation. Note:
The possible values for this attribute are defined by the ST_Xstring simple type (§3.18.96). |
|
Specifies the data source type. Values are as follows: 1. ODBC-based source 2. DAO-based source 3. File based database source 4. Web query 5. OLE DB-based source 6. Text-based source 7. ADO record set 8. DSP The possible values for this attribute are defined by the XML Schema unsignedInt datatype. |
The following XML Schema fragment defines the contents of this element:
<complexType name="CT_Connection">
<sequence>
<element name="dbPr" minOccurs="0" maxOccurs="1" type="CT_DbPr"/>
<element name="olapPr" minOccurs="0" maxOccurs="1" type="CT_OlapPr"/>
<element name="webPr" minOccurs="0" maxOccurs="1" type="CT_WebPr"/>
<element name="textPr" minOccurs="0" maxOccurs="1" type="CT_TextPr"/>
<element name="parameters" minOccurs="0" maxOccurs="1" type="CT_Parameters"/>
<element name="extLst" minOccurs="0" maxOccurs="1" type="CT_ExtensionList"/>
</sequence>
<attribute name="id" use="required" type="xsd:unsignedInt"/>
<attribute name="sourceFile" use="optional" type="ST_Xstring"/>
<attribute name="odcFile" use="optional" type="ST_Xstring"/>
<attribute name="keepAlive" use="optional" type="xsd:boolean" default="false"/>
<attribute name="interval" use="optional" type="xsd:unsignedInt" default="0"/>
<attribute name="name" use="optional" type="ST_Xstring"/>
<attribute name="description" use="optional" type="ST_Xstring"/>
<attribute name="type" use="optional" type="xsd:unsignedInt"/>
<attribute name="reconnectionMethod" use="optional" type="xsd:unsignedInt" default="1"/>
<attribute name="refreshedVersion" use="required" type="xsd:unsignedByte"/>
<attribute name="minRefreshableVersion" use="optional" type="xsd:unsignedByte" default="0"/>
<attribute name="savePassword" use="optional" type="xsd:boolean" default="false"/>
<attribute name="new" use="optional" type="xsd:boolean" default="false"/>
<attribute name="deleted" use="optional" type="xsd:boolean" default="false"/>
<attribute name="onlyUseConnectionFile" use="optional" type="xsd:boolean" default="false"/>
<attribute name="background" use="optional" type="xsd:boolean" default="false"/>
<attribute name="refreshOnLoad" use="optional" type="xsd:boolean" default="false"/>
<attribute name="saveData" use="optional" type="xsd:boolean" default="false"/>
<attribute name="credentials" use="optional" type="ST_CredMethod" default="integrated"/>
<attribute name="singleSignOnId" use="optional" type="ST_Xstring"/>
</complexType>