eBiss 3

Hilfe & Dokumentation

Benutzer-Werkzeuge

Webseiten-Werkzeuge


Seitenleiste

Themen

howtos:plugins:pluginwebexample:webplugin

Web-Plugin erstellen

Um eine ASPX Seite in die eBiss Web Page zu intergrieren, lassen Sie Ihre Klasse von der Schnittstelle eBiss.Api.IWebPlugin erben und verwenden als Basisklasse eBiss.WebPlugin.Sample.WebPluginBasePage.

  • Über das Interface IWebPlugin definieren Sie, in welcher Gruppe und unter welchem Namen Ihre Web Seite erscheint.
  • Die Klasse WebPluginBasePage stellt die IWebSession bereit, bzw. leitet an das Login weiter.

Im Page_Load rufen Sie die Methode OnPageLoad() aus der Basisklasse auf.

[DisplayName("Name Of Sidemenu Subpoint")] //This Attribut will be the name of the sidemenu subpoint.
public partial class SamplePage: WebPluginBasePage, IWebPlugin
{
   //Implement interface member
 
    public WebPageKind Kind
    {
        get { return WebPageKind.RootPage; }
    }
 
    //1. if DisplayName is not set, groupname will be used. 
    //2. Identifier for the pages. One Group is able to have more than one page
    public string GroupName 
    {
        get { return "Name for Sidemenu Group"; }
    }
 
    //Name of the page. In this Example: Sidemenu Name: MyPluginPage, Pagename: MyPage
    public string PageName 
    {
        get { return "MyPage"; }
    }
 
    //Uri for the .aspx site. Usually the same as the classname
    public string Uri 
    {
        get { return "PlugIns/MyPluginPage.aspx"; }
    }
 
    protected void Page_Load(object sender, EventArgs e)
    {
       base.OnPageLoad();
       ...
    }
 
}

Über die Eigenschaft EBissSession der Basisklasse können die z.B. nach Dokumenten suchen:

foreach (IDocument doc in EBissSession.DataApplication.Find("eBiss.Data.Document", $"DocNumber.StartsWith(\"{value}\")"))
{
   Data.MessageItem msgItem = new Data.MessageItem(doc);
   source.Add(msgItem);
}

Exception Handling

Damit eBiss Web Ihre auftretenden Exceptions an die eBiss Web Errorpage weiterreicht, rufen Sie RedirectToErrorPage() auf:

Code-Beispiel2: Exception Handling.

// don't catch redirect exception!
try
{
    if (!IsPostBack)
    {
        ...
    }
}
catch (Exception ex)
{
    RedirectToErrorPage(ex);
}

Anschließend benötigt das eBiss Verzeichnis sowohl Ihre Plugin-DLL als auch die kompilierten .aspx Seiten.

Kopieren Sie deshalb die DLL unter: .eBiss 3\Webs\eBiss\bin\PlugIns

Die .aspx Seiten unter: .eBiss 3\Webs\eBiss\PlugIns

Starten Sie anschließend den eBiss Dienst neu und löschen Sie ggfs. den Cache Ihres Browsers.

howtos/plugins/pluginwebexample/webplugin.txt · Zuletzt geändert: 2024/02/20 08:15 von 127.0.0.1