Freigeben über

Разработка веб-части автогенерации кода проекта Project Server 2013 (Часть 1)

  • Artikel

Статья Андрея Путина (Компания Бастион-Интегратор), первоначально опубликованная здесь.

Или как получить строку подключения к БД Project Server 2013?

В этой статье мы начнем разрабатывать веб-часть автогенерации уникального кода проекта и разберем следующие вопросы:

  • Написание простейшей веб-части
  • Получение строки подключения к БД Project Server 2013.

При разработке кастомного расширения для Project Server 2013 нередко возникает задача записи или чтения из БД Project Server 2013, при этом возникает вопрос как получить валидную строку подключения к БД, не выносить же ее в настройки или хуже того использовать «хардкод». Итак, для создания нашей веб-части выполним следующие шаги:

1. Создадим новый проект в Visual Studio и дадим обдуманное название, так как наша веб-часть будет генерировать Id проекта, то дадим «обдуманное» название «SampleProjectUniqueIDWebPart».

2. Выберем тип развертывания нашего решения. В данном примере я использую тип развертывания Deploy as a farm solution, так как моя веб-часть будет содержать UserControl.

3. Добавим References (ссылки) на сборки в GAC:

  • Microsoft.Office.Project.Server.PWA.dll
  • Microsoft.Office.Project.Server.Library.dll
  • Microsoft.Office.Project.Schema.dll

для лентяев J

C:\Windows\Microsoft.NET\assembly\GAC_MSIL\Microsoft.Office.Project.Schema\v4.0_15.0.0.0__71e9bce111e9429c\Microsoft.Office.Project.Schema.dll

C:\Windows\Microsoft.NET\assembly\GAC_MSIL\Microsoft.Office.Project.Server.Library\v4.0_15.0.0.0__71e9bce111e9429c\Microsoft.Office.Project.Server.Library.dll

C:\Windows\Microsoft.Net\assembly\GAC_MSIL\Microsoft.Office.Project.Server.PWA\v4.0_15.0.0.0__71e9bce111e9429c\Microsoft.Office.Project.Server.PWA.dll

4. После создания нового проекта добавим новый элемент (Add New Item) нашу веб-часть.

5. В разделе Office/SharePoint выберем Web-Part и дадим имя нашей веб-части

6. Перейдем в SolutionExplorer и развернем добавленную веб-часть.

7. Выберем элемент ProjectUniqueIDWebPart.webpart откроем его двойным нажатием мыши и откорректируем свойства веб-части в разделе xml схемы <properties>

<property name="Title" type="string"> Project Unique ID WebPart</property>
<property name="Description" type="string"> Веб-часть автоматической генерации Id проекта</property>

8. Наследуем класс веб-части ProjectUniqueIDWebPart от класса PWAPart

9. Откорректируем раздел Using:

  1. using System;  
  2. using System.Web.UI;  
  3. using System.Linq;  
  4. using System.Web.UI.WebControls;  
  5. using System.Web.UI.WebControls.WebParts;  
  6. using Microsoft.SharePoint.WebPartPages;  
  7. using Microsoft.Office.Project.Server.Schema;  
  8. using Microsoft.Office.Project.PWA;  
  9. using System.Web;  
  10. using Microsoft.SharePoint;  
  11. using Microsoft.SharePoint.Utilities;  
  12. using System.Xml;  
  13. using System.Drawing;  
  14. using System.Collections.Generic;  
  15. using Microsoft.Office.Project.PWA.WebParts;  
  16. using Microsoft.Office.Project.Server.Library;  
  17. using System.ComponentModel;   

10. Создадим новый Class для отображения настроек веб-части дадим имя класса ProjectUniqueIDToolPart.cs.

11. Наследуем класс ProjectUniqueIDToolPart.cs от класса ToolPart.

public class ProjectUniqueIDToolPart : ToolPart

{  

}

12. Добавим новый элемент проекта (Add New Item) User Control в разделе Office/SharePoint

13. Заготовка под нашу веб-часть готова, теперь перейдем к маленьким заделам на будущее:

Для начала напишем класс ToolPart для сохранения настроек ProjectUniqueIDToolPart.cs.

  1. using System;  
  2. using System.Collections.Generic;  
  3. using System.Linq;  
  4. using System.Text;  
  5. using Microsoft.SharePoint.WebPartPages;  
  6. using System.Web.UI.WebControls;  
  7.   
  8. namespace SampleProjectUniqueIDWebPart.ProjectUniqueIDWebPart  
  9. {  
  10.     public class ProjectUniqueIDToolPart : ToolPart  
  11.     {  
  12.         #region Members  
  13.         Panel toolPartPanel;  
  14.         private TextBox _txtCustomFieldUid;  
  15.         private ProjectUniqueIDWebPart _webpart;  
  16.         #endregion  
  17.  
  18.         #region ToolPart Events  
  19.   
  20.         protected override void CreateChildControls()  
  21.         {  
  22.             _webpart = ParentToolPane.SelectedWebPart  
  23.                 as ProjectUniqueIDWebPart;  
  24.             toolPartPanel = new Panel();  
  25.             toolPartPanel.ID = «toolPartPanel»;  
  26.   
  27.             _txtCustomFieldUid = new TextBox();  
  28.   
  29.             if (_webpart != null)  
  30.             {  
  31.                 _txtCustomFieldUid.Text = _webpart.DefaultCustomFieldUid;  
  32.                 _txtCustomFieldUid.Width = 200;  
  33.             }  
  34.   
  35.             toolPartPanel.Controls.Add(_txtCustomFieldUid);  
  36.             Controls.Add(toolPartPanel);  
  37.             base.CreateChildControls();  
  38.         }  
  39.   
  40.         public override void ApplyChanges()  
  41.         {  
  42.             base.ApplyChanges();  
  43.             _webpart.DefaultCustomFieldUid = _txtCustomFieldUid.Text;  
  44.         }  
  45.  
  46.         #endregion  
  47.     }  
  48. }  

После чего отредактируем класс ProjectUniqueIDWebPart.

  1. using System;  
  2. using System.Web.UI;  
  3. using System.Linq;  
  4. using System.Web.UI.WebControls;  
  5. using System.Web.UI.WebControls.WebParts;  
  6. using Microsoft.SharePoint.WebPartPages;  
  7. using Microsoft.Office.Project.Server.Schema;  
  8. using Microsoft.Office.Project.PWA;  
  9. using System.Web;  
  10. using Microsoft.SharePoint;  
  11. using Microsoft.SharePoint.Utilities;  
  12. using System.Xml;  
  13. using System.Drawing;  
  14. using System.Collections.Generic;  
  15. using Microsoft.Office.Project.PWA.WebParts;  
  16. using Microsoft.Office.Project.Server.Library;  
  17. using System.ComponentModel;  
  18. using SampleProjectUniqueIDWebPart.ControlTemplates.SampleProjectUniqueIDWebPart;  
  19.   
  20. namespace SampleProjectUniqueIDWebPart.ProjectUniqueIDWebPart  
  21. {  
  22.     [ToolboxItemAttribute(false)]  
  23.     public class ProjectUniqueIDWebPart : PWAPart  
  24.     {  
  25.         private const string _ascxPath = @«~/_CONTROLTEMPLATES/15/SampleProjectUniqueIDWebPart/ProjectUniqueIDUserControl.ascx»;  
  26.         public string DefaultCustomFieldUid { get; set; }  
  27.           
  28.   
  29.         protected override void PWA_OnLoad(EventArgs e)  
  30.         {  
  31.             this.Height = «100%»;  
  32.   
  33.             base.PWA_OnLoad(e);  
  34.         }  
  35.   
  36.         protected override void PWA_CreateChildControls()   
  37.         {  
  38.             ProjectUniqueIDUserControl control = (ProjectUniqueIDUserControl)Page.LoadControl(_ascxPath); //Инициализация пользовательского контрола  
  39.             control.ParentWP = this;  
  40.             control.DefaultCustomFieldUid = DefaultCustomFieldUid;  
  41.             Controls.Add(control);//Добавляем контрол   
  42.               
  43.             base.PWA_CreateChildControls();//Вызваем метод базового класса  
  44.         }  
  45.   
  46.         public override Microsoft.SharePoint.WebPartPages.ToolPart[] GetToolParts()  
  47.         {  
  48.             ToolPart[] allToolParts = new ToolPart[3]; //Инициализации массива панелей инструментов свойств веб-части  
  49.             WebPartToolPart standardToolParts = new WebPartToolPart(); //Стандартная панель инеструментов  
  50.             CustomPropertyToolPart customToolParts = new CustomPropertyToolPart();  
  51.   
  52.             allToolParts[0] = standardToolParts;  
  53.             allToolParts[1] = customToolParts;  
  54.             allToolParts[2] = new ProjectUniqueIDToolPart //Добавляем нашу расширенную панель инструментов  
  55.             {  
  56.                 Title = «Корпоративное настраиваемое поле по умолчанию»  
  57.             };  
  58.             return allToolParts;  
  59.         }  
  60.     }  
  61. }  

Отредактируем элемент ProjectUniqueIDUserControl.ascx выбрав его двойным щелчком Solution Explorer. Добавим в следующую строку:

  1. <asp:Label ID=«lblMessage» runat=«server» Text=«NA» style=«font-weight: 700″></asp:Label>.   

После чего отредактируем частичный класс ProjectUniqueIDUserControl.ascx.cs

  1. using System;  
  2. using System.Web.UI;  
  3. using System.Linq;  
  4. using System.Web.UI.WebControls;  
  5. using System.Web.UI.WebControls.WebParts;  
  6. using Microsoft.SharePoint.WebPartPages;  
  7. using Microsoft.Office.Project.Server.Schema;  
  8. using Microsoft.Office.Project.PWA;  
  9. using System.Web;  
  10. using Microsoft.SharePoint;  
  11. using Microsoft.SharePoint.Utilities;  
  12. using System.Xml;  
  13. using System.Drawing;  
  14. using System.Collections.Generic;  
  15. using Microsoft.Office.Project.PWA.WebParts;  
  16. using Microsoft.Office.Project.Server.Library;  
  17. using System.Reflection;  
  18.   
  19.   
  20. namespace SampleProjectUniqueIDWebPart.ControlTemplates.SampleProjectUniqueIDWebPart  
  21. {  
  22.     public partial class ProjectUniqueIDUserControl : UserControl  
  23.     {  
  24.         protected Label lblMessage;  
  25.   
  26.         public ProjectUniqueIDWebPart.ProjectUniqueIDWebPart ParentWP;  
  27.         public string DefaultCustomFieldUid { get; set; }  
  28.   
  29.         protected void Page_Load(object sender, EventArgs e)  
  30.         {  
  31.             lblMessage.Text = GetDbConnectionString(PJContext.Current.Site.ID);   
  32.         }  
  33.   
  34.   
  35.         public string GetDbConnectionString(Guid pwaSiteId)  
  36.         {  
  37.             return “”;   
  38.         }  
  39.     }  
  40. }  

Вроде все готово, теперь осталось понять, как получить строку подключения? Так как данной функции нет в документации к стандартному API, я использую инструмент реверс-инжиниринга Reflector для анализа сборок Project Server 2013.

Проанализировав код, мы понимаем, что класс ProjectSite internal sealed class, в котором содержится нужный нам метод, а это означает что в «лоб» его не использовать, но мы не будем вешать нос, а воспользуемся рефлексией. После небольших «мытарств» наш с вами класс выглядит теперь так:

  1. using System;  
  2. using System.Web.UI;  
  3. using System.Linq;  
  4. using System.Web.UI.WebControls;  
  5. using System.Web.UI.WebControls.WebParts;  
  6. using Microsoft.SharePoint.WebPartPages;  
  7. using Microsoft.Office.Project.Server.Schema;  
  8. using Microsoft.Office.Project.PWA;  
  9. using System.Web;  
  10. using Microsoft.SharePoint;  
  11. using Microsoft.SharePoint.Utilities;  
  12. using System.Xml;  
  13. using System.Drawing;  
  14. using System.Collections.Generic;  
  15. using Microsoft.Office.Project.PWA.WebParts;  
  16. using Microsoft.Office.Project.Server.Library;  
  17. using System.Reflection;  
  18.   
  19.   
  20. namespace SampleProjectUniqueIDWebPart.ControlTemplates.SampleProjectUniqueIDWebPart  
  21. {  
  22.     public partial class ProjectUniqueIDUserControl : UserControl  
  23.     {  
  24.         protected Label lblMessage;  
  25.   
  26.         public ProjectUniqueIDWebPart.ProjectUniqueIDWebPart ParentWP;  
  27.         public string DefaultCustomFieldUid { get; set; }  
  28.   
  29.         protected void Page_Load(object sender, EventArgs e)  
  30.         {  
  31.             lblMessage.Text = GetDbConnectionString(PJContext.Current.Site.ID);  
  32.         }  
  33.   
  34.   
  35.         private static object GetProjectSite(Guid pwaSiteId)  
  36.         {  
  37.             Type psiServiceType = Type.GetType(«Microsoft.Office.Project.Server.Administration.PsiService, Microsoft.Office.Project.Server.Administration, Version=15.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c»);  
  38.   
  39.             Microsoft.SharePoint.Administration.SPService psiService = (Microsoft.SharePoint.Administration.SPService)psiServiceType.GetProperty(«Local», BindingFlags.Static | BindingFlags.Public).GetValue(null, new object[0]);  
  40.             Microsoft.SharePoint.Administration.SPServiceApplication psiServiceApplication = psiService.Applications.Where(item => item.GetType().Name == «PsiServiceApplication»).FirstOrDefault();  
  41.   
  42.             object projectSiteCollection = psiServiceApplication.GetType().GetProperty(«SiteCollection»).GetValue(psiServiceApplication, new object[0]);  
  43.   
  44.             object projectSite = projectSiteCollection.GetType().GetMethod(«GetProjectSite», new Type[] { typeof(Guid) }).Invoke(projectSiteCollection, new object[] { pwaSiteId });  
  45.             return projectSite;  
  46.         }  
  47.   
  48.   
  49.   
  50.         public string GetDbConnectionString(Guid pwaSiteId)  
  51.         {  
  52.             object projectSite = GetProjectSite(pwaSiteId);  
  53.             Microsoft.SharePoint.Administration.SPDatabase projectDataBase = (Microsoft.SharePoint.Administration.SPDatabase)projectSite.GetType().GetProperty(«ProjectServiceDatabase»).GetValue(projectSite, new object[0]);  
  54.             return projectDataBase.DatabaseConnectionString;  
  55.         }  
  56.     }  
  57. }  

 « Билдим » наш проект и разворачиваем на тестовую ферму.

Проверяем работоспособность нашей веб-части.

Для этого открываем PWA переходим в Центре проектов на тестовый проект, нажимаем отредактировать страницу «Карточки проекта».

Добавляем нашу веб-часть на страницу.

Ура! Все работает. Мы теперь научились получать connection string.

В следующей части мы будем реализовывать логику генерации ID проекта и записи его в настраиваемое поле проекта.