Marcel Gnoth, OFF4 - IBF 1.5 Information Bridge Framework 1.5 verbindet Web Services und Office...

Marcel Gnoth, www.gnoth.net

OFF4 - IBF 1.5

Information Bridge Framework 1.5 verbindet Web Services und

Office System 2003

Marcel Gnoth, www.gnoth.net 2

Zur Person• Dipl. Inf. Marcel Gnoth, MCSD

• www.gnoth.net

• NTeam GmbH, Berlin• www.nteam.de• Leiter Softwareentwicklung• MS Gold Partner: Busines Intelligence, Information Worker,

Advanced Infrastructur

• Autor dotnetpro, dotnet-magazin, ComputerWorld, MSDN• Trainer (u.a. SPC Berlin, www.spc.de )• Themen

• VB6, COM, SQL Server• Verteilte nachrichtenbasierte Informationssysteme• Office System 2003 Integration• Reisen in ferne Länder: www.gnoth.net/reise.htm

http://www.gnoth.net/

http://www.nteam.de/

http://www.spc.de/

http://www.gnoth.net/reise.htm




Agenda

• Einführung• Demo Contoso• Architektur• Ablauf eines IBF-Projektes• Der Webservice und die Geschäftsklassen• Eine einfache IBF-Lösung erstellen

• Meta Data Import, Wizards, Test

• Smart Tag erstellen• Schlussfolgerungen


Information Bridge Framework

Office Dokumente mit verschiedenen LOB – Daten verknüpfen


Warum IBF ?

Find Customer Account Rep

Find Orders

MS Word Task Pane

Option1Option1

Child

ChildChildChild

Label

LabelMary : Ford order is late. Please investigate.

Unproduktiv und Fehleranfällig!

Copy & Paste

• Emails und Dokumente beziehen sich auf Geschäfts-Entitäten• Kunde, Bestellung, ...

• Oft befinden sich die Daten in verschiedenen Systemen

• Es gibt keinen einfachen Weg diese Daten in Beziehung zu setzen

• Einarbeitung in die Systeme• Copy & Paste ist einzige

Integration


Warum IBF• Verknüpft Office Dokumente mit Daten• Zugriff auf Daten über Webservices• Informationen werden komfortabel in der TaskPane angezeigt

• Wenig Programmieren, deklarativer Ansatz• Dafür gute XML-Kenntnisse erforderlich


Demo

Was kann IBF


IBF-Überblick-Grafik• Web Service-basierende Architektur (SOA)• Zentraler Metadaten / GUI Server• Runtime für Smart Tag /

XML Ereignis Initiierung• Windows Forms und

Taskpane Unterstützung

MetadataMetadata

FinanceFinance

ERPERP

CRMCRM

Smart ClientsSmart Clients

Web Web ServicesServices

Web Web ServicesServices


IBF-Architektur

Windows 2003 Server Services

.NET Framework

IBF Metadata Store

SQL Server 2000

IBF (Metadata Service)

Windows Client

XML

Microsoft Office Professional Edition

Web Services.NET Framework

Information Bridge Framework

Client Server

CRM

ERP Other Data

Metadata Service

In

form

ati

on B

ridg

e E

ngin

e1User selects “Show

Details” from Smart

Tag

2

CAS Interprets “Context” using Metadata

3Call Web Service to retrieve data

Smart TagDisplays data in Taskpane

5

4 Returns data


IBF-Architekur

Legacy Legacy AppApp

Workflow Workflow EngineEngine

SiebelSiebelSAPSAPMS-CRMMS-CRM

Information BridgeInformation Bridge

Back-end ServicesBack-end Services

ClientClient

Office Office ApplicationApplication

Smart TagSmart Tag

Smart DocSmart Doc

Task Pane Task Pane ManagerManager

Host Host RendererRenderer

IBF - UIIBF - UI

IBF IBF EngineEngine

Metadata Metadata CacheCache

Metadata Metadata DesignerDesigner

Metadata Metadata Web ServiceWeb Service

MetadataMetadata

Compliant Compliant Service Service AdapterAdapter

Compliant Compliant Service Service AdapterAdapter

Compliant Compliant Service Service (Native)(Native)

BizTalk BizTalk EAIEAI

Existing Existing Web Web

ServiceService

XML Instance XML Instance DataData

MetadataMetadata


Installation

• Server• Windows 2003 + IIS für IBF-Webservices• SQL Server 2000 +• MOIBF 1.0 Server

• Client• Office 2003 (mit Primary Interop Assemblies !!!)• Visual Studio 2003• MOIBF 1.5 Client (Anwender, Entwickler)• MOIBF 1.5 Meta Data Designer (Entwickler)

• LOB – Webservices


IBF-Entwicklung

Let‘s walking through the dark forest …


Eine IBF-Lösung• IBF ist ein Framework für:

• Zugriff auf Webservices• Zugriff auf Assemblies• Anzeige von Informationen in der TaskPane• Interaktion mit SmartTags

• Eigentlich keine Programmierung • Alles XML-Metadaten (XML, XSD, XSL, XPath)• Ausnahmen

• SmartTag (Standardlösungen vorhanden)• Evtl. UserControls (können vom Wizard generiert werden)• Evtl. WinForms• Evtl. Webservices für LOB-Zugriff• Evtl. Office Automation


Bestandteile eines IBF-Projektes• Metadaten

• Bestehen aus XML, sie sind das IBF-Projekt• Befinden sich alle in einer XML-Datei

• Smart Tags• Interaktion zwischen Office Dokumenten und IBF• Aktivierung der IBF-Aktionen

• Eigene Bezutzerschnittstellen• UserControls, WinForms

• Webservice• Lesen und schreiben der Daten• Evtl. BL-Komponenten


Vorgehen bei IBF Programmierung1. Gründliche Planung (Use Cases)

2. Definition von Artefakten und Entitäten1. Ansichten (View) der Entitäten (Geschäftsobjekte)

2. Referenzen (Reference) für Zugriff auf Entitäten

3. Beziehungen (RelationShip) zwischen Entitäten

4. Operationen (Operation)

3. Webservices• Nach Möglichkeit an IBF angepasst

4. Metadaten mit VS 2003 erstellen, Designer + Wizards

5. SmartTag mit VS 2003 programmieren

6. GUI entwickeln (UserControls, WinForms)• nicht zwingend


Planung

• Anzeige eines Kunden aus der NorthWind-DB• Suche nach KundenID (ALFKI, LETSS, … )• Definition von Entitäten

• Kunde• Bestellung

• Operationen• Was soll mit den Entitäten geschehen?• Kunde laden, speichern (get, put)• Bestellstatus ändern (act)


IBF – Views • Darstellung einer Entität

• Mind. eine Default-View• Mehrere Views für eine Entität möglich

• Views in XML planen

<Customer xmlns="NTeam-Data"><CustomerID></CustomerID><CompanyName></CompanyName><ContactName></ContactName><ContactTitle></ContactTitle> <EMail></ EMail >

<Region></Region><Phone></Phone></Customer>

<Customer xmlns="NTeam-Data"><CustomerID></CustomerID><CompanyName></CompanyName><ContactName></ContactName><ContactTitle></ContactTitle> <EMail></ EMail >

<Region></Region><Phone></Phone></Customer>

<BookView xmlns=" NTeam-Data"><ISBN></ISBN>

<Title></Title><SuggestedPrice></SuggestedPrice></BookView>

<BookView xmlns=" NTeam-Data"><ISBN></ISBN>

<Title></Title><SuggestedPrice></SuggestedPrice></BookView>


IBF – References

• Ähnlich einem Primärschlüssel• Ermöglichen Zugriff auf eine bestimmte Entität• ViewLocator

• Mehrere Referenzen für eine Entität möglich• Mind. eine Default-Referenz• Kunde – KundenID• Kunde – Email

<CustomerID ID="ALFKI" xmlns=" NTeam-Data " />

<CustomerEmail Address="[email protected]" xmlns="NTeam-Data" />

<BookIDReference ISBN=”0972317937” xmlns="NTeam-Data"/>

<CustomerID ID="ALFKI" xmlns=" NTeam-Data " />

<CustomerEmail Address="[email protected]" xmlns="NTeam-Data" />

<BookIDReference ISBN=”0972317937” xmlns="NTeam-Data"/>


IBF – Relationships

• Stellen Verbindung zwischen zwei Views her• Zum Beispiel:

• View-Customer und View-Orders sind verbunden über eine CustomerID-Referenz

• Navigation zwischen Geschäftsobjekten


Relationships von verschiedenen LOB Systemen

Office 2003Office 2003

IBF EngineIBF EngineMetadata

CacheMetadata

Cache

Information WorkerInformation Worker

Client sideClient side

Server sideServer side

Pubs databaseFulfillment

System

Web Service Web Service

Relationship in Metadata

• Informationen können aus mehreren LOB’s zusammengesammelt werden


Erstellen von Geschäftsklassen

• Nur, wenn Sie den Webservices selber erstellen• Für jede View und für jede Referenz eine Klasse

erstellen• Diese Klassen mit XML-Attributen versehen

• Werden vom SOAP Formatter in das geplante XML serialisiert

• Diese Klassen dienen als Parameter für die zu erstellenden Webservices


Erstellen der Customer-Klasse

• Klasse Customer mit XML-Attributen für den SOAP-Formatter

[XmlRoot("Customer",Namespace="Customer-Data",IsNullable=false)][XmlType("Customer", Namespace="Customer-Data")]public class Customer {

// Customer ID[XmlElement]public string CustomerID {

get{return this._CustomerID;}set{this._CustomerID = value;}

}// Company Name[XmlElement]public string CompanyName {

get{return this._CompanyName;}set{this._CompanyName = value;}

}...

}

[XmlRoot("Customer",Namespace="Customer-Data",IsNullable=false)][XmlType("Customer", Namespace="Customer-Data")]public class Customer {

// Customer ID[XmlElement]public string CustomerID {


}// Company Name[XmlElement]public string CompanyName {

get{return this._CompanyName;}set{this._CompanyName = value;}

}...

}


Erstellen der CustomerID-Referenz• Klasse Customer_ID mit XML-Attributen für den

SOAP-Formatter• Analoge Klassen für die anderen Referenzen

(Email, …)

//<CustomerID CustomerID="ANYCUSTOMERID" xmlns="CustomerID-Data"/>[XmlRoot("CustomerID", Namespace="CustomerID-Data",IsNullable=false)][XmlType("CustomerID", Namespace="CustomerID-Data")]public class Customer_ID {

// Fieldsprivate string _CustomerID;// Customer ID Attribute[XmlAttribute]public string CustomerID {


}}

//<CustomerID CustomerID="ANYCUSTOMERID" xmlns="CustomerID-Data"/>[XmlRoot("CustomerID", Namespace="CustomerID-Data",IsNullable=false)][XmlType("CustomerID", Namespace="CustomerID-Data")]public class Customer_ID {

// Fieldsprivate string _CustomerID;// Customer ID Attribute[XmlAttribute]public string CustomerID {


}}


Erstellen der Webservices

• Beliebige Webservices können eingesetzt und kombiniert werden

• Eigene Webservices für beliebigen Datenzugriff• Können an IBF angepasst erstellt werden• Weniger Transformationen

• LOB-Webservices• Können genauso verwendet werden

• Drei Arten von Webmethoden• Get, Put, Act


Get-Methoden

• Liefern Entitäten als View zurück• Bekommen meist eine Referenz übergeben

[WebMethod]public Customer GetCustomer(Customer_ID objCustomerID) { ... }

[WebMethod]public Customer GetCustomer(Customer_ID objCustomerID) { ... }


Put-Methoden

• Aktualisieren eine Entität im LOB-System mit den View-Daten

[WebMethod]public void PutCustomer(Customer objCustomer) { ... }

[WebMethod]public void PutCustomer(Customer objCustomer) { ... }


Act-Methoden

• Operationen, die über das Lesen und Schreiben von Entitäten hinausgehen

• z.B. BestellStatus ändern

[WebMethod]public void ChangeOrderStatus(OrderID orderID, OrderStatus status) { ... }

[WebMethod]public void ChangeOrderStatus(OrderID orderID, OrderStatus status) { ... }


Test-Methoden

• Webservices haben komplexe Datentypen als Parameter (Referenzen,…)

• Können nicht direkt mit dem IE getestet werden• Deshalb Testmethoden mit einfachen

Parametern

[WebMethod]public Customer GetCustomerTest(string strCustomerID) { ... }

[WebMethod]public Customer GetCustomerTest(string strCustomerID) { ... }


Coding

Geschäftsklassen und Webservices


Metadaten erzeugen

Meta Data Explorer und Wizards


Metadaten anlegen• Zwei Gruppen von Metadaten• Daten und Logik

• Webservice Zugriffe• Operations, Entities

• Darstellung• Views• GUI-Elemente in der TaskPane


Metadaten-Typen

• Metadata = Ein Projekt der IBF Lösung• Entity = Geschäftsobjekt• View = eine Ansicht eines Geschäftsobjektes• Port = Quelle für XML, Daten, Schemata, …• Schema = XML-Schema • Transformation = wandelt XML in anderes XML


Arten von Meta Daten

Relationship View 2

Entity

Scope

EntityEntity 2

Operation

Instance

View Locator

View 1

Entity 1

Operation

Instance

View Locator

PortPort


IBF-Projekt anlegen

• Neuer Projekttyp in Visual Studio .Net 2003• Enthält nur eine Datei: MSIBFMetadata.xml• Metadata Explorer

• Bearbeiten der MetaDaten

• MetaData Guidance• Wizards


Importieren von Meta Daten• XML-Datei mit den MetaDaten ist leer• Eine Vorlage aus dem Ressource Kit

• MOIBF1.5_Reskit_Templates• Microsoft.InformationBridge.

Framework.UI.InformationBridgeScope.Metadata.xml

• WSDL vom Webservice


Demo

Importieren der Meta Daten


Views erstellen

Service Metadata Creation Wizard


Entity, View und ViewLocator• Mit Wizard Artefakte erstellen• Entity = Customer• View = Darstellung der Entity• ViewLocator besorgt die Daten für die View


Demo

Service Metadata Creation Wizard


Region Creation Wizard

Die Darstellung


Die GUI


Region Creation Wizard• Erzeugt eine Region

• UserControl• HTML

• Erzeugt eine Action• Für die Darstellung

• Bug bei nicht englische.Net• Wizard verwendet XSD.exe und prüft englische

Textausgaben!! • Lösung: Ressource-Datei umbennen

C:\Programme\Microsoft Visual Studio .NET 2003\SDK\v1.1\Bin\DE\xsd.resources.dll


Action• Besteht aus mehreren Operation-Instanzen


Aktions Designer – Parameter • Die Operationen können sequentiell ausgeführt werden• Über Transformationsinstanzen können Ein- und

Ausgabeparameter zwischen den Operationsinstanzen zugewiesen werden


Aktionen testen

Build & Execute Action Button

Build & Execute Action Context Menu Item


Aktionen testen

• ControlLib Assembly mit StrongName versehen• Full Trust für Assembly auf Machinenebene

einstellen

• Erwarten Input-Parameter wie im Schema der Referenz definiert

<CustomerID ID="ALFKI" xmlns="CustomerID-Data" /> <CustomerID ID="ALFKI" xmlns="CustomerID-Data" />


Demo

Erstellen einer Region

Testen der Action


IBF – Smart Tags

Ein bisschen Code muss sein!


Was sind SmartTags?

• Verknüpfen Text in Dokumenten mit Geschäftsprozessen

Smart Tag Action Button

Lila gepunktete Linie: Smart Tag Kennzeichnung


Entwicklung von Smart Tags• Microsoft Office Smart Tag List (MOSTL)

• Für “einfache” Smart Tags• Leichte Entwicklung und Deployment• Können automatisch aktualisiert werden

• Smart Tag API• Alle Möglichkeiten des .Net Frameworks• Programmierung (COM-Interface)

• C#, VB.NET, C++ oder VB6• .Net Applikationen verwenden COM Interop oder VSTO Loader

• Benötigen Setup (Einträge in die Registry)

• IBF-SmartTags sind anders als die anderen


IBF Smart Tag Projekt

• Dll Projekt, mit Strong Name, FullTrust !!!• Referenzen auf:

• Microsoft.InformationBridge.Framework.Interfaces• Microsoft.InformationBridge.Framework.UI.Interop• COM: Microsoft.Office.Interop.SmartTag

(Microsoft Smart Tags 2.0 Type Library)

• Implementieren der Interfaces:• IRecognizer• IActionHandler


IRecognizer

• IRecognizer.Initialize • Laden von Daten

• IRecognizer.Recognize• Word-Paragraph, Excel-Cell, Buchstabe oder Wort,…

• SmartTag wird in das Dokument eingebettet• Spezielles XML-Element: ContextInformation• muss IBF Schema entsprechen


ContextInformation-Element

• Diese Informationen werden vom SmartTag in das Dokument eingebettet

<ContextInformation xmlns="http://.../InformationBridge/2004/ContextInformation“ MetadataScopeName="NorthwindIBF3" EntityName="Customers ViewName="Customer_View" ReferenceSchemaName="Xsd.CustomerID (CustomerID-Data)"> <Reference> <CustomerIDReference <CustomerID CustomerID=“ALFKI" xmlns="CustomerID-Data" /> </CustomerIDReference> </Reference></ContextInformation>

<ContextInformation xmlns="http://.../InformationBridge/2004/ContextInformation“ MetadataScopeName="NorthwindIBF3" EntityName="Customers ViewName="Customer_View" ReferenceSchemaName="Xsd.CustomerID (CustomerID-Data)"> <Reference> <CustomerIDReference <CustomerID CustomerID=“ALFKI" xmlns="CustomerID-Data" /> </CustomerIDReference> </Reference></ContextInformation>


IActionHandler

• Eigene Kontextmenüeinträge• Sonst nur Standardeintrag: ShowDetails

• Eigene Aktionen


Demo

Ein SmartTag für IBF


SmartTag mit IBF verknüpfen

• Normale SmartTags werden als COM-Komponente registriert

• IBF Client verfügt über Genric Recognizer• IBF-SmartTags werden mit der

MetaDataSolution verknüpft• Werden dann von IBF Engine geladen


Generic SmartTag Recognizer• Import Meta Data vom Ressourcekit• Ports

• GenericSmartTags: Pfad zum Assembly• GenericRecognizer: Namespace.Klasse des Recognizers• LoadRecognizer-Operation verweist bereits auf

GenericSmartTag-Port

• Action• Entities > GenericSmartTags

> Views > GenericRecognizers > Actions > AddAction


Action und Operation verknüpfen


Testen

• Meta Data Projekt als Startprojekt• Projekteigenschaften

MetaData/Action Debugger Mode• MetaData, Managed, Native

• BreakPoints im SmartTag-, UserControl-Code• BreakPoints im MetaData-Explorer


Publishing Metadata• Bis jetzt Meta Daten nur auf Client• Beim Debuggen werden MetaDaten des VS-

Projektes verwendet• Meta Daten müssen auf den Server


Publish Metadata Dialog

• URL zum IBF-Write-WebService

• Clients kennen den Read-WebService

• Office-Applikationenladen MetaDaten


The Publishing Process

Metadata ServicesMetadata Services

VS .NETVS .NET

Metadata DesignerMetadata Designer

SQL ServerSQL Server

Client sideClient side

Server sideServer side

Office 2003Office 2003

IBF EngineIBF EngineMetadata

CacheMetadata

Cache

Information WorkerInformation Worker Solution DeveloperSolution Developer

ReadRead WriteWrite

XML File


Fazit• Hohe Lernkurve

• Sehr gute XML, XSL, XSD, … Kenntnisse !

• Entwicklung wird noch nicht genug unterstützt• Version 1.5 seit QI 2005• Unterstützung für Entwickler stark verbessert

• Zugriff auf beliebige Webservices möglich• Metadaten werden einfacher, wenn die Webservices sich

„wohlverhalten“ • Get und Put für Entitäten, Beziehungen zwischen Entitäten

• VSTO 2005 bietet ähnliche Funktionalität• Leichter für Entwickler mit .net Erfahrung

• Auf dem Client muss IBF Runtime sein


Mendocino

• Vorgefertigte IBF-Lösungen• Mit SAP


Ressourcen

• Vijay Desai. (Sep, 2004), http://www.persistent.co.in/knowledgecenter/InformationBridgeFramework.pdf

• IBF-Buch• Code Project WalkThrough• IBF-MOC Kurs• Ressource Kit• NewsGroup


Alles wird gut

Uff...Uff...

Marcel Gnoth, OFF4 - IBF 1.5 Information Bridge Framework 1.5 verbindet Web Services und Office...

Documents

Transcript of Marcel Gnoth, OFF4 - IBF 1.5 Information Bridge Framework 1.5 verbindet Web Services und Office...