Веб-часть XmlViewer


Download    Для WSS v.3       User Guide     Отзывы, комментарии           English             Top               

 Назначение

Веб-часть XmlView предназначена для установки на узлах (сайтах) в составе Microsoft SharePoint Portal Server или Microsoft SharePoint Services.

Веб-часть используется для просмотра xml–файлов и списков Шарепойнт с использованием xslt–стилей. Имеются варианты как для работы с Шарепойнт в.2, так и с Шарепойнт в.3.


 

Установка

Извлеките из архива xmlviewer.zip (xmlviewer3.zip) файл XmlViewer.cab и выполните команду

"C:\Program Files\Common Files\Microsoft Shared\web server extensions\60(12)\BIN\STSADM.EXE" -o addwppack -filename XmlViewer.cab

На странице веб-частей выберите из группы «Галерея виртуальных серверов» веб-часть XmlViewer, перетащите её в нужное место и настройте параметры.

 В файле web.config укажите <trust level="Full" originUrl="" />

 

Параметры веб-части

Параметры для удобства заполнения разделены на группы по смыслу.

Группа XML

XML Document

Текст xml–документа, предназначенного к показу.

XML Link

Ссылка на документ. Может быть указан URL файла на удалённом сервере или относительный путь к файлу на локальном сервере.

В поле могут быть указаны несколько ссылок, разделённых символом «;».

Документ(ы) по ссылкам загружаются только при отсутствии текста валидного документа в поле XML Document.

Группа Xsl

XSL Script

Текст Xsl–скрипта для преобразования данных.

XSL Link

Ссылка на документ. Может быть указан URL файла на удалённом сервере или относительный путь к файлу на локальном сервере.

При отсутствии текста или ссылки на xsl–скрипт используется встроенный простой стиль отображения xml–документов.

No Default XSL

Не использовать встроенный стиль.

Группа Rss

XSL Script

Текст Xsl–скрипта для преобразования данных при работе в режиме RSS.

XSL Link

Ссылка на документ, который будет использован в качестве скрипта при работе в режиме RSS. Может быть указан URL файла на удалённом сервере или относительный путь к файлу на локальном сервере.

RSS Encoding

Кодировка выходного потока. Кодировка может быть задана как именем, так и номером кодовой страницы: utf–8, 1251, windows–1251 etc. По умолчанию используется кодировка UTF-8.

RSS Id

Идентификатор веб-части. Используется при работе в режиме RSS.

При отсутствии значения в поле будет установлено случайное уникальное значение.

I am Alone

Этот экземпляр является единственной на странице веб–частью данного типа.

Группа List

List Link

Ссылка на один или несколько списков Шарепойнт. Ссылки разделены символом «;».

Формат ссылки на список:

[url]/<ListName>[|idx] , где url – абсолютный или относительный путь к сайту, содержащему список с именем ListName),
idx – список идентификаторов записей (целые числа через «,», символ «
|» - элемент синтаксиса).

Например: /sites/info/ListName|2,5,13

Список может находиться также на другом компьютере (удалённый список).

Lists Merge variant

Тип слияния данных нескольких списков. Значение выбирается из ряда 1, 2.

По умолчанию параметр имеет значение 1.

Bad Symbols
 processing

Вариант обработки имён полей списков, содержащих «плохие» символы:

1 – выдать предупреждение о невозможности использовать такое имя в качестве имени тега <имя_поля>…</имя_поля >;

2 – формировать теги вида
<
field name=”имя_поля”>…</field>

По умолчанию параметр имеет значение 1.

Format of date/time field

Форматная строка (по правилам форматирования в .NET), которая будет использована при выводе данных типа DateTime.
Например, «yyyy.MM.dd HH:mm»

Группа Cache

Do Not Cache

Не использовать кеширование данных.

Path to Cache

Папка для сохранения кешированных данных. Напр., ~/cachedir

Группа View

Empty Banner

Текст, выводимый в поле веб-части при отсутствии данных. Параметр может содержать произвольный html–текст, отвечающий задаче, для которой используется веб-часть. Например, “ Просмотр <b>XML</b> &amp; <b>SPList</b> [<i>при помощи XSL</i>]”.

Наряду с текстом, параметр может содержать ссылку на документ в библиотеке SharePoint в формате «!!D:url_сайта::имя_библиотеки::имя_файла», где "!!D:" - признак ссылки, "::"   - разделитель полей ссылки.

Например, «!!D:/configs::Templates::emptyXV.htm».

Группа Common

Do Not Trace

Отключить выполнение трассировки работы веб-части.

 

 Алгоритм работы

Указанные в параметрах XML–документы загружаются во временные объекты типа XmlDocument.

Указанные в параметрах списки Шарепойнт преобразуются в формат xml–документов.

Получившиеся объекты объединяются в один XmlDocument, к которому применяется Xsl–стиль (указанный в параметрах или встроенный). В xsl–скрипт передаются все параметры из Url страницы, на которой размещена веб–часть.

Результирующий документ имеет следующую структуру (значение параметра Lists Merge variant равно 1):

<Root>

      <содержимое документа_1>

     

      <содержимое документа_n>

      <Rows>

            <Row><данные строки списка></Row>

            … данные всех строк всех списков …

      </Rows>

</Root>

При значении параметра 2 данные списков разделены:

<Root>

      <содержимое документа_1>

     

      <содержимое документа_n>

      <list>

<Row><данные строк списка_1></Row>

</list>

     

      <list>

<Row><данные строк списка_n></Row>

</list>

</Root>

При отсутствии xml–документов тег <Root> заменяется на <Lists>.

 

Удалённые списки

При указании в поле List Link списка, расположенного на удалённом сервере, извлечение данных производится через соответствующий веб-сервис. Для обеспечения доступа к сервису в файле web.config виртуального сервера, на котором установлена веб–часть, можно добавить данные пользователя, от имени которого будет выполняться обращение к веб–сервису (при отсутствии параметров будут использованы данные текущего пользователя):

 

<add key="GlobalAdminName" value="name" />

<add key="GlobalAdminDomain" value="domain" />

<add key="GlobalAdminPassword" value="password" />

 

Режим RSS

В режиме RSS веб-часть формирует выходной текст в соответствии с параметрами группы RSS.

Переход в режим RSS происходит при указании в адресе (URL) страницы параметров XMLVRss=<RSSId>. При установленном значении параметра I am Alone режим RSS включается независимо от значения параметра XMLVRss.

При работе в этом режиме все прочие элементы страницы  в формировании вывода не учитываются.

 

Кеширование данных

Используется для ускорения вывода редко изменяющихся данных. Сформированный выходной поток сохраняется в файле, при обращении к веб–части с теми же параметрами вычислений не производится, выводятся сохранённые данные. Учитываются все параметры групп XML, XSL и List, а также параметры в URL страницы, на которой находится веб-часть.

 

Трассировка

При установленном параметре выполняется трассировка основных этапов формирования выходного текста.  Результаты трассировки записываются в виде комментариев в выходной поток.

 <!-- ##Trace of […]:

start=13.09.2006 22:28:01, end=13.09.2006 22:28:01, duration=0,109 sec. <=> Initializing

start=13.09.2006 22:28:01, end=13.09.2006 22:28:01, duration=0,000 sec. <=> Loading XML

start=13.09.2006 22:28:01, end=13.09.2006 22:28:02, duration=0,719 sec. <=> Loading XSL

start=13.09.2006 22:28:02, end=13.09.2006 22:28:02, duration=0,047 sec. <=> Loading ListData

start=13.09.2006 22:28:01, end=13.09.2006 22:28:02, duration=0,875 sec. <=> From start to end of data loading

start=13.09.2006 22:28:01, end=13.09.2006 22:28:06, duration=5,281 sec. <=> from start to begin of Rendering

start=13.09.2006 22:28:06, end=13.09.2006 22:28:06, duration=0,000 sec. <=> Load HTML from cache

start=13.09.2006 22:28:01, end=13.09.2006 22:28:06, duration=5,281 sec. <=> Total executing time -->