Новые возможности Business Connectivity Services в SharePoint 2013 – Создание внешнего типа контента на основе источника OData

Сегодня я хочу начать серию статей о новых возможностях компонента Business Connectivity Services (BCS), доступных в SharePoint 2013. Первая из таких возможностей – это поддержка внешних типов контента (External Content Types), подключающихся к источнику OData. В этой статье на простом примере мы рассмотрим как это реализовать.

1. Для успешного выполнения данного примера вам потребуется:
   • Microsoft SharePoint 2013 Preview
   • Microsoft Visual Studio 2012
   • Microsoft Office Developer Tools for Visual Studio 2012 – Preview
   • Источник данных OData (несколько примеров, которые можно использовать, указаны здесь Live Services)
2. Первым делом запустите Visual Studio 2012
3. Создайте новый проект
4. В дереве типов проектов раскройте узел “Office/SharePoint”, выберете тип “Apps” и щёлкните значок “Apps for SharePoint 2013”
5. Введите имя проекта, например “ODataECTDemo” и нажмите “OK”.  
   
6. В следующем диалоговом окне введите имя сайта, который будет использоваться для отладки приложения, и способ размещения приложения. Я выбрал “SharePoint-hosted” в этом примере. Нажмите “Finish”.
   
7. Для того, чтобы добавить внешний тип контента, щёлкните правой кнопкой мыши проект “ODataECTDemo” на панели “Solution Explorer”, выберете меню “Add”, а затем из выпадающего меню выберете пункт “Content Types for External Data Source”. Откроется окно мастера подключения источника OData и создания внешнего типа контента.
   
8. На первом шаге мастера введите имя, например,“ODataTestService”, и URL источника OData, который вы планируете использовать (Я в этом примере выбрал вот этот http://services.odata.org/OData/OData.svc/ ). Нажмите “Next”.
   
9. На этом шаге выберете те сущности, для которых вы хотите создать внешние типы контента. Можно выбрать один или несколько. В этом примере я выбрал одну сущность “Product”. Чтобы добавить внешний список автоматически при развертывании приложения, убедитесь, что отмечена галочка  "Create list instances for the selected data entries (except Service Operations)". Нажмите “Finish”.
   
10. На панели “Solution Explorer” вы можете заметить, что Visual Studio автоматически создала новую папку “External Content Types” в дереве проекта. Давайте в нее заглянем и посмотрим, что там.
    
11. Раскрыв папку “External Content Types”, вы можете увидеть созданный внешний тип контента, который соответствует выбранной в мастере сущности. В моем случае – это Product.ect. Его можно открыть как в графическом режиме
    
12. так и как обычный xml файл, если его открыть с помощью xml редактора.
    
13. Еще один сгенерированный файл  - это xml файл экземпляра списка, ассоциированного с внешним типом данных. Запомните относительный URL этого списка, так как он нам потребуется в дальнейшем. В моем случае URL такой “Lists/Product”    
    
14. Теперь нам нужно выполнить построение и развертывание приложения, для этого нажмите F5 в Visual Studio. После развертывания откроется страница “Site Contents” и наше приложение будет доступно в списке всего содержимого сайта.
    
15. Щёлкнув на приложение “ODataDemo”, откроется стартовая страница приложения (та, которая определена в свойстве “StartPage” файла проекта AppManifest.xml). По умолчанию – это достаточно простая страница, которая отображает заголовок нашего приложения и имя пользователя, запустившего приложение. Наведите мышку на имя приложения и запомните его URL, который потребуется на следующем шаге. В моем случае URL приложения такой http://app-e139481b3ba396.aquarius.sharepoint.local/ODataECTDemo/
    
16. Теперь нам необходимо открыть внешний список, который создался автоматически. Для этого составьте URL следующим способом: URL приложения (из шага №15)+относительный URL внешнего списка(из шага №13). У меня этот URL выглядит так http://app-e139481b3ba396.aquarius.sharepoint.local/ODataECTDemo/Lists/Product. Введите этот URL в браузере. “Вуаля!” – перед нами внешний список на странице SharePoint 2013, который отображает данные OData канала.
    
17. Для упрощения отладки вы можете сделать так, чтобы внешний список сразу открывался при запуске приложения. Для этого необходимо изменить файл AppManifest.xml приложения. Откройте этот файл в xml редакторе Visual Studio, найдите элемент “StartPage” и замените предыдущее значение на новое:~appWebUrl+относительный URL внешнего списка(из шага №13). В моем случае это выглядит так: <StartPage>~appWebUrl/Lists/Product</StartPage>.
    
18. Снова нажмите F5 в Visual Studio и, щёлкнув затем приложение “ODataDemo”, теперь вы увидите внешний список на стартовой странице.