Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »


primedocs Connect ist eine XML Schnittstelle um die Dokumenterzeugung teilweise oder vollständig zu automatisieren. Connect kann sowohl client- als auch serverseitig verarbeitet werden.

<primedocsConnect>
   ...
</primedocsConnect>

Template

Über das Template-Element kann gezielt eine Vorlage angesprochen werden oder es kann eine Filterung aufgrund von Tags vorgenommen werden.

Id

Über das Id-Attribut wird die Vorlage für die Dokumentverarbeitung gewählt. Als Angabe dafür muss die genaue GUID der Vorlage übergeben werden.

<primedocsConnect>
  <Template Id="30b55516-80b5-41d7-801b-b31d6da376ac" />
  ...
</primedocsConnect>

TagFilter

Der TagFilter ist nur clientseitig implementiert.

Über das TagFilter-Element können Tags zur Filterung angegeben werden.

<primedocsConnect>
  <Template>
    <TagFilter>
      <Tag>Tag1</Tag>
      <Tag>Tag2;Tag3;Tag4</Tag>
    </TagFilter>
  </Template>
  ...
</primedocsConnect>

AND-Verknüpfungen werden innerhalb eines Tag-Elements durch Semikolons getrennt definiert, OR-Verknüpfungen durch mehrere Tag-Elemente.
Das obige Beispiel zeigt alle Vorlagen, die mit Tag1 oder Tag2, Tag3 und Tag4 markiert sind.

Standardmässig wird erwartet, dass die Filterung nur eine Vorlage als Ergebnis liefert. Liefert die Abfrage mehrere Vorlagen, wird eine Fehlermeldung anzeigt.

Über das AllowTemplatePicker-Attribut kann optional ein Auswahldialog angezeigt werden, dieser zeigt dann alle resultierenden Vorlagen an.

<primedocsConnect>
  <Template>
    <TagFilter AllowTemplatePicker="true">
      <Tag>Tag1</Tag>
      <Tag>Tag2;Tag3;Tag4</Tag>
    </TagFilter>
  </Template>
  ...
</primedocsConnect>

DocumentLanguage

Über das DocumentLanguage-Element mit dem Code-Attribut kann die Zieldokumentsprache angegeben werden.

<primedocsConnect>
  <DocumentLanguage Code="de-ch" />
  ...
</primedocsConnect>

Wird keine DocumentLanguage angegeben, wird die Standardsprache der primedocs Datenquelle genommen.


Author

Das Author-Element kann genutzt werden um die Dokumenterzeugung mit einem bestimmten Profil und einem bestimmten Thema zu starten.

<primedocsConnect>
  <Author>
    <Profile Id="08be85c8-d12a-4e8c-b1aa-9f56e5f6ed38" ThemeId="Red" />
  </Author>
  ...
</primedocsConnect>

Über das Id-Attribut kann ein bestimmtes Profil ausgewählt werden. Das ThemeId-Attribut kann genutzt werden um ein bestimmtes Thema auszuwählen.

Ohne Angabe eines expliziten Profiles wird das aktuelle Profile des primedocs-Clients verwendet bzw. auf Serverseite das erste Profil des jeweiligen Benutzers.


Forms

Die Dokumentfunktion Formulare (Forms) dient dazu Daten vor der Dokumentgenerierung abzufragen. Die konfigurierten Eigenschaften können auch über die Connect Schnittstelle vorausgefüllt werden.

<primedocsConnect>
  <Forms>
	<!-- "Simple" mappings to Text/Choice/Date/... -->
    <Value Key="Subject">Sample letter</Value>
	<Value Key="Note">Another sample</Value>
	
	<!-- Target is an Object -->
    <Object Key="Recipient">
      <Value Key="Name">John Doe</Value>
      <Value Key="Address">Sample Street 123, 12345 City</Value>
    </Object>

	<!-- Target is an ObjectCollection -->
	<ObjectCollection Key="Topics">
	  <Item>
	    <Value Key="Name">Sample 1</Value>
	  </Item>
	  <Item>
	    <Value Key="Name">Sample 2</Value>
	  </Item>
	  <Item>
	    <Value Key="Name">Sample 3</Value>
	  </Item>
	  <Item>
	    <Value Key="Name">Sample 4</Value>
	  </Item>
   </ObjectCollection>
  </Forms>
  ...
</primedocsConnect>

Über Connect wird nur die “Ziel-Id” des jeweiligen Elements angegeben samt dem Inhalt. Hierbei werden 3 verschiedene Typen unterschieden:

  • “Normale” Elemente können über <Value Key="ElementId">Wert</Value> befüllt werden.

  • Objekte (Object), wie z.B. Personenangaben über das Elternelement <Object Key="ElementId" /> samt <Value Key="ElementId">Wert</Value> für die Kindelemente.

  • Objektlisten (ObjectCollection) für Auflistungen von Daten, wobei jeder Datensatz in einem Item-Element ist.

  • No labels