Table of Contents |
---|
...
Arguments
Über die Connect-Arguments können Vorlage, Sprache, Profil, Organsiationseinheit und andere Parameter für den Aufruf definiert werdenThe Connect arguments can be used to define template, language, profile, organsiation unit and other parameters for the call.
Code Block | ||
---|---|---|
| ||
<OneOffixxConnectBatch> <Entries> <OneOffixxConnect> <Arguments> ...this hieris gehörenwhere diethe Argumentearguments hinbelong </Arguments> ... </OneOffixxConnect> </Entries> </OneOffixxConnectBatch> |
...
TemplateId:
...
Template selection
The template for document processing is selected via the TemplateId. For specification the exact GUID must be passed.
Code Block | ||
---|---|---|
| ||
<TemplateId>6bb49520-1ebd-4f68-bb5f-02f46a9e1ec8</TemplateId> |
...
TemplateTags:
...
Template selection
Code Block | ||
---|---|---|
| ||
<TemplateFilter> <Tag>Tag1</Tag> <Tag>Tag2;Tag3;Tag4</Tag> </TemplateFilter> |
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. Gibt es mehrere Vorlagen, die den Filterkriterien entsprechen oder wird weder ein TemplateTag noch eine TemplateId angegeben, öffnet sich ein Auswahldialog, durch den der Benutzer die gewünschte Vorlage auswählen kann.
...
TemplateTags können auch serverseitig genutzt werden. Falls es mehrere Vorlagen gibt, die dem Filterkriterium entsprechen, wird stets der erste Eintrag genommen. Die Reihenfolge ist dabei nicht garantiert!
LanguageLcid: Auswahl der Sprache
Über LanguageLcid wird die Dokumentsprache für die Verarbeitung gesetzt. Es muss eine genaue LCID angegeben werden. Die meistgenutzten LCIDs sindlinks are defined within a tag element separated by semicolons, OR links are defined by multiple tag elements. The above example shows all templates tagged with Tag1 or Tag2, Tag3 and Tag4. If there are multiple templates that match the filter criteria or if neither a TemplateTag nor a TemplateId is specified, a selection dialog opens through which the user can select the desired template.
...
TemplateTags can also be used on the server side. If there are several templates that match the filter criterion, the first entry is always taken. The order is not guaranteed!
...
LanguageLcid: Language selection
LanguageLcid is used to set the document language for processing. An exact LCID must be specified. The most used LCIDs are:
LCID | Tag | SpracheLanguage |
---|---|---|
1031 | de-DE | Deutsch German - DeutschlandGermany |
2055 | de-CH | Deutsch German - SchweizSwitzerland |
1033 | en-USEnglisch - Vereinigte Staaten von Amerika | English - United States of America |
2057 | en-GBEnglisch | English - GrossbritannienUnited Kingdom |
4108 | fr-CH | Französisch French - SchweizSwitzerland |
1036 | fr-FR | Französisch French - FrankreichFrance |
2064 | it-CH | Italienisch Italian - SchweizSwitzerland |
1040 | it-IT | Italienisch Italian - ItalienItaly |
...
DocumentLocation:
...
Selection of an existing document
The DocumentLocation can be used to update existing documents or to merge two existing documents.
Code Block | ||
---|---|---|
| ||
<DocumentLocation>c:\Temp\Doc1.docx</DocumentLocation> |
...
ProfileId:
...
Über das ProfileId-Element kann ein bestimmtes Profil ausgewählt werden. Ohne Angabe eines expliziten Profiles wird das aktuelle Profile des primedocs-Clients verwendet bzw. auf Serverseite das erste Profil des jeweiligen Benutzers. Es gibt zwei Möglichkeiten, das Profil auszuwählen:
...
Selection of the profile
The ProfileId element can be used to select a specific profile. Without specifying an explicit profile the current profile of the primedocs client will be used or on server side the first profile of the respective user. There are two ways to select the profile:
By profile id
Code Block |
---|
<ProfileId>25558547-a6fb-4fad-908b-63118dcee5c9</ProfileId> |
...
By profile name
Code Block |
---|
<ProfileId>Hans<ProfileId>Jane Muster<Doe</ProfileId> |
...
ThemeId
Diese Funktion steht nur in den neuen Vorlagtypen zur Verfügung. Weitere Informationen finden Sie hier.
...
Note |
---|
This function is only available for "classic" templates. You can find more information here. |
A specific theme can be selected via the ThemeId element. If no explicit theme is specified, the default theme is used by the organizational unit.
Code Block |
---|
<Profile> <ThemeId>CustomThemeId</ThemeId> </Profile> |
...
OrganizationId:
...
Diese Option erlaubt es, eine beliebige (freigegebene) Organisation in der Profildaten- und Themes-Dokumentfunktion zu nutzen. Wird die angegebene Organisation gefunden, werden für den Aufruf die entsprechenden Organisationsdaten genutzt. Sie kann über zwei Arten gesucht werden.
...
Selection of the organizational unit
This option allows to use any (released) organization in the Profile data and Themes document functions. If the specified organization is found, the corresponding organization data is used for the call. It can be searched for in two ways.
By organization id
Code Block | ||
---|---|---|
| ||
<Profile> <OrganizationId>25558547-a6fb-4fad-908b-63118dcee5c9</OrganizationId> </Profile> |
Über Abfrage
...
By query
In the field name, all configured fields for organizational units can be used. If more than one organization is found, the first one will be taken, whereby no order is guaranteed.
Code Block | ||
---|---|---|
| ||
<Profile> <OrganizationId>{Org.Name = IT-Abteilung department}</OrganizationId> </Profile> |
Die Syntax lautet dabeiThe syntax is: { Feldname field name = Wert value }
Note |
---|
IMPORTANT |
...
The found organizational unit replaces the actually configured organizational unit for the currently selected profile during document creation. |
...
Version: Document version selection
Code Block | ||
---|---|---|
| ||
<Version>Draft</Version> |
Mittels der Version-Angabe kann exakt gesteuert werden, welche Version der Vorlage dabei im Editor geöffnet wird. Wenn mit Filter oder ohne TemplateId aufgerufen wird, kann dazu auch der TemplatePicker benutzt werden.
Folgende Werte sind möglich:
...
Wert
...
Id-Typ
...
Version der ausgewählten Vorlage
...
Aufgelöste Version der Abhängigkeiten
...
The version specification can be used to control exactly which version of the template is opened in the editor. If called with filter or without TemplateId, the TemplatePicker can also be used for this.
The following values are possible:
Value | Id type | Version of the selected template | Resolved version of the dependencies | TemplatePicker |
---|---|---|---|---|
Published | Template-ID | Published | Published | ✓ |
PublishedDraft | Template-ID | Published | Draft | ✓ |
Draft | Template-ID | Draft | Draft | ✓ |
SpecificDraft | Versions-Template-Id | Specific | Draft | |
SpecificPublished | Versions-Template-Id | Specific | Published |
...
Editor:
...
Mode selection (for Type Data)
Falls If Connect mit is used with Type Data eingesetzt wird, kann über diesen Parameter festgelegt werden, dass die Vorlage im Editor-Modus in Word geöffnet werden soll, um die Felder zu platzieren, this parameter can be used to specify that the template should be opened in editor mode in Word in order to place the fields.
Code Block | ||
---|---|---|
| ||
<Editor>true</Editor> |
...