Custom Interface Connector
- Daniela Zimmermann
- Dinah Bolli (Unlicensed)
Wird primedocs aus einer Fachapplikationen heraus aufgerufen, können fachapplikationsspezifische Daten an die Vorlage übergeben werden. Element- und Attributnamen sind frei wählbar bzw. können von der Fachapplikation definiert und angepasst werden. Pro Schnittstelle muss ein eindeutiger Schnittstellename definiert werden. Dadurch ist primedocs in der Lage, die Daten intern zu transformieren und für die Dokumentgenerierung aufzubereiten.
<Interface Name="ExampleInterface" />
Beispielkonfiguration:
<Function name="CustomInterfaceConnector" id="70E94788-CE84-4460-9698-5663878A295B">
<Arguments>
<Interface Name="ExampleInterface">
<Node Id="KeyA">ValueA</Node>
<Node Id="KeyB">ValueB</Node>
<Node Id="KeyC">ValueC</Node>
</Interface>
</Arguments>
</Function>Transformation
primedocs transformiert das XML der Fachapplikation in ein internes Format. Dazu muss in der Vorlage die Dokumentfunktion Connect-Schnittstellendefinition angehängt und konfiguriert werden.
Es ist möglich, Bilder in Form einer URL oder im Base64-Format zu übergeben. Dafür muss im Node Element das Attribut Type="Image" zusätzlich angeben werden. Sofern eine URL übergeben wird, muss der Client und/oder der Server Lesezugriff auf die Bilder haben.
Beispiel einer Transformationskonfiguration; die Elementinhalte werden als Beispielinhalte während der Designphase verwendet:
<InterfaceDescription Name="CollectionDemo">
<Node Id="SimpleBindingOne" XPath="//SimpleBindingOne">SimpleBindingOneText</Node>
<Node Id="SimpleBindingTwo" XPath="//SimpleBindingTwo">SimpleBindingTwoText</Node>
<Node Id="SimpleBindingThree" XPath="//SimpleBindingThree">SimpleBindingThreeText</Node>
<NodeCollection Id="ListBinding" XPath="//List/EachElement">
<Node Id="Firstname" XPath="./FirstName" /> // these Elements are beneath <EachElement>
<Node Id="Surname" XPath="./Surname" /> // these Elements are beneath <EachElement>
<NodeCollection Id="Orders" XPath="./Orders/Order"> // even Collection in Collections are supported
<Node Id="OrderId" XPath="./Id" />
<Node Id="OrderProduct" XPath="./Product" />
</NodeCollection>
</NodeCollection>
<!-- Bild wird im Base64-Format übergeben -->
<Node Id="PictureSample" Type="Image" XPath="//PictureSample" >iVBORw0KGgoAAAANSUhEUgAAAF8AAAB4CAIAAAAbh7ksAAAAAXNSR0IArs4c6QAAAARnQU1BAACx
jwv8YQUAAAAJcEhZcwAADsMAAA7DAcdvqGQAAAAZdEVYdFNvZnR3YXJlAHBhaW50Lm5ldCA0LjAu
MTHaDTpWAAAA8UlEQVR4Xu3QQQ0AIAwAMfz/UIS0oWCnoEkV9Nw3bOwUO8VOsVPsFDvFTrFT7BQ7
xU6xU+wUO8VOsVPsFDvFTrFT7BQ7xU6xU+wUO8VOsVPsFDvFTrFT7BQ7xU6xU+wUO8VOsVPsFDvF
TrFT7BQ7xU6xU+wUO8VOsVPsFDvFTrFT7BQ7xU6xU+wUO8VOsVPsFDvFTrFT7BQ7xU6xU+wUO8VO
sVPsFDvFTrFT7BQ7xU6xU+wUO8VOsVPsFDvFTrFT7BQ7xU6xU+wUO8VOsVPsFDvFTrFT7BQ7xU6x
U+wUO8VOsVPsFDvFTrFT7BQ7xc7uzQeYsdPzpHNxAAAAAABJRU5ErkJggg==</Node>
<!-- Bild wird als URL übergeben -->
<Node Id="PictureFilePathSample" Type="Image" XPath="//PictureFilePathSample" /> <!-- The file path needs file:// as a prefix -->
</InterfaceDescription>
Beispiel-Aufruf, wobei eine Transformation konfiguriert wird:
Beispiel der dazugehörigen Connectfiles:
Data CustomInterface
Wird das Interface mit type='Data' mitgegeben, muss kein konfiguriertes Interface in der Konfiguration hinterlegt sein. Die Daten werden als CustomXmlNodes interpretiert und sind sowohl im Editor als auch im Dokument verfügbar.
Beispiel:
PrimeSoft AG, Bahnhofstrasse 4, 8360 Eschlikon, Switzerland