2.2.4.51 OpenWorkbookInParameters

SharePoint

Namespace: http://schemas.microsoft.com/office/Excel/Server/WebServices/ExcelServerInternalService/

Input parameters for OpenWorkbook (section 3.1.4.30).

 <xs:complexType name="OpenWorkbookInParameters" xmlns:xs="http://www.w3.org/2001/XMLSchema">
   <xs:sequence>
     <xs:element minOccurs="0" maxOccurs="1" name="Url" type="xs:string"/>
     <xs:element minOccurs="0" maxOccurs="1" name="Canary" type="xs:string"/>
     <xs:element minOccurs="0" maxOccurs="1" name="SubscriberId" type="xs:string"/>
     <xs:element minOccurs="1" maxOccurs="1" name="Flags" type="tns2:OpenWorkbookFlags"/>
     <xs:element minOccurs="0" maxOccurs="1" name="CultureCommandParameter" type="tns2:CultureCommandParameter"/>
     <xs:element minOccurs="0" maxOccurs="1" name="DocumentProperties" type="xs:base64Binary"/>
     <xs:element minOccurs="0" maxOccurs="1" name="WacUserSessionId" type="xs:string"/>
     <xs:element minOccurs="0" maxOccurs="1" name="PreviousSessionId" type="xs:string"/>
     <xs:element minOccurs="0" maxOccurs="1" name="UserId" type="xs:string"/>
     <xs:element minOccurs="0" maxOccurs="1" name="UserFriendlyName" type="xs:string"/>
     <xs:element minOccurs="0" maxOccurs="1" name="TimeZoneSerialization" type="xs:string"/>
     <xs:element minOccurs="1" maxOccurs="1" name="UserScenarioRestrictions" type="tns2:ScenarioRestrictions"/>
     <xs:element minOccurs="1" maxOccurs="1" name="ThrottlingScenario" type="tns2:ResourceThrottlingScenario"/>
     <xs:element minOccurs="0" maxOccurs="1" name="DenylistOverrides" type="xs:string"/>
     <xs:element minOccurs="1" maxOccurs="1" name="ExcelFeatures" type="tns2:ExcelServerFeature"/>
   </xs:sequence>
 </xs:complexType>

Url:  If flags does not contain the NewWorkbook value (section 2.2.5.23), the location of the workbook file. Otherwise, the trusted location of the new workbook session. MUST be present. If the specified value is not a Uniform Resource Identifier (URI), as specified in [RFC2396], or a Universal Naming Convention (UNC), the protocol server MUST return an ExcelServerMessage as specified in section 2.2.4.24, with the value of the Id element of the ExcelServerMessage set to one of the following:

  • "FileOpenNotFound", if flags does not contain the value "NewWorkbook".

  • "NewWorkbookInvalidLocation", if flags contains the value "NewWorkbook".

The protocol server ignores the number sign (#) and fragment, as specified in [RFC3986].

Canary: MUST NOT be used.

SubscriberId: The site identifier. MUST be equal to the value of RequestSiteId passed in parameter.

Flags:  Control flags, as specified in section 2.2.5.23.

CultureCommandParameter: UI culture, data culture and host data language related information. MUST be present.

DocumentProperties: MUST NOT be used.

WacUserSessionId: MUST NOT be used.

PreviousSessionId:  If present, MUST be a session identifier as returned in the workbookId as specified in OpenWorkbookResponse (section 3.1.4.30.2.2). MUST NOT be present for any operations other than OpenWorkbook. MUST NOT be present for OpenWorkbook when a workbookId is present in CommandParameter (section 2.2.4.20) in the request message of the same operation.

UserId: MUST NOT be used.

UserFriendlyName: The user display name. MUST be present.

TimeZoneSerialization: The time zone of the session. MUST be present. MUST be exactly 73 characters long. MUST have the following layout, which is specified using ABNF, as specified in [RFC2234] and described in the following table.

TimeZone

=

Bias "#" StandardDate "#" StandardBias "#" DaylightDate "#" DaylightBias

Bias

=

"+"\"-" 4DIGIT

StandardDate

=

Date %d84 Time

StandardBias

=

"+"\"-" 4DIGIT

DaylightDate

=

Date %d84 Time

DaylightBias

=

"+"\"-" 4DIGIT

Date

=

Year "-" Month "-" DayOfWeek "-" Day

Time

=

Hour ":" Minute ":" Second ":" Millisecond

Year

=

4DIGIT

Month

=

2DIGIT ; 01-12

DayOfWeek

=

2DIGIT ; 00-06 (Sunday-Saturday)

Day

=

2DIGIT ; 01-31

Hour

=

2DIGIT ; 00-23

Minute

=

2DIGIT ; 00-59

Second

=

2DIGIT ; 00-59

Millisecond

=

4DIGIT

The following restrictions MUST apply on the TimeZoneSerialization:

  • Bias MUST be the time zone bias.

  • StandardDate MUST be the time zone standard date.

  • StandardBias MUST be the time zone standard bias.

  • DaylightDate MUST be the time zone daylight date.

  • DaylightBias MUST be the time zone daylight bias.

  • The following restrictions are specified in [RFC3339]:

    • Month MUST be date-month.

    • Day MUST be date-day.

    • Hour MUST be time-hour.

    • Minute MUST time-minute.

    • Second MUST be time-second.

  • DayOfWeek MUST have one of the values described in the following table.

    Value

    Meaning

    00

    Sunday

    01

    Monday

    02

    Tuesday

    03

    Wednesday

    04

    Thursday

    05

    Friday

    06

    Saturday

 

UserScenarioRestrictions: If the value of ProtocolClientId element in the parameter as defined in section 2.2.4.20 is set to "ms-soap", the protocol client MUST set the value to LegacyWebServices. Otherwise, MUST NOT be used.

ThrottlingScenario: MUST NOT be used.

DenylistOverrides: MUST NOT be used.

ExcelFeatures: Contains features (section 2.2.5.10) to be enabled in the workbook on the protocol server.

Show: