Table of Contents

Mit dieser Dokumentfunktion können verschiedene Objekte verteilt werden, so z. B. PDF-Dokumente, Bilder oder auch macro-basierte AddIns für Excel oder PowerPoint. Die Dokumentfunktion wird auch für Mail Themes mit den benötigten Styles in Mail-Vorlagen und -signaturen benötigt. In der folgenden Tabelle werden einige Elemente erklärt:

...

Tag

...

Erklärung

...

Path

...

Hier kann der Ablageort der betroffenen Datei gewählt werden.

...

Lockfile

...

So kann verhindert werden, dass eine geöffnete Datei verändert wird. Dazu kann die betroffene Datei samt Endung angegeben werden.

...

Merge

...

Es kann bestimmt werden, ob die Datei(en) bei einer Aktualisierung ersetzt, entfernt oder zusammengeführt werden soll(en).

...

Die Dokumentfunktion steht exklusiv bei folgenden Vorlagentypen zur Auswahl: "Externe Datei für Verteilung" und This document function can be used to distribute various objects, such as PDF documents, images or macro-based add-ins for Excel or PowerPoint. The document function is also needed for mail themes with the required styles in mail templates and signatures. In the following table some elements are explained:

Tag	Explanation
Path	The storage location of the affected file can be selected here.
Lockfile	This can be used to prevent an open file from being modified. For this purpose, the affected file including extension can be specified.
Merge	It can be determined whether the file(s) should be replaced, removed or merged during an update.

The document function is available exclusively for the following template types: "External file for distribution" and "Mail Theme".

...

"Scriptable"

Die Vorlagenverteilung ist in der Lage, bestimmte System-Variablen auszulesen und so – je nach Umgebung – andere Dateien auszurollen. Das ist z. B. notwendig, um mit einem Office AddIn Paket verschiedene Office-Versionen zu unterstützen. Dabei kann auf das System der "Scriptable Configs" zurückgegriffen werden.

Das API-Objekt hat folgende Eigenschaften jeweils für The template distribution is able to read certain system variables and thus – depending on the environment – roll out other files. This is necessary to support different Office versions with an Office Add-In package for example. The system of "Scriptable Configs" can be used for this.

The API object has the following properties for Word, Excel, PowerPoint und and Outlook respectively:

Feld	Werte	Beschreibung
IsDetected	`Boolean` true / false	Gibt zurück, ob das Office-Produkt installiert istReturns whether the Office product is installed.
Version	`Integer`	Gibt die installierte Office-Version zurückReturns the installed Office version.
Is32Bit	`Boolean` true / false	Gibt zurück, ob das Office-Produkt in der Returns whether the Office product is installed in the 32-bit Version installiert istversion.
Is64Bit	`Boolean` true / false	Gibt zurück, ob das Office-Produkt in der Returns whether the Office product is installed in the 64-bit Version installiert istversion.

So gibt z. B. For example, oo.Word.Version die installierte Word-Version zurück, falls oo.Word.IsDetected true zurückgibt returns the installed Word version if oo.Word.IsDetected returns true.

Office -Versionenversions

Office -Versionversion	Office 'JahreszahlYear'
14	2010
15	2013
16	2016/2019

...

Cleanup

Mittels Cleanup können erstellte Registrywerte und Dateien/Ordner wieder gelöscht werden. Es stehen drei Befehle zur VerfügungUsing Cleanup created registry values and files/folders can be deleted again. Three commands are available:

Code Block

language	xml

<File Path="Path to File or Folder" />

Das löscht die Datei oder den Ordner (inkl. Unterordner). Es werden auch Wildcards unterstützt: d. h. mittels This deletes the file or folder (including subfolders). Wildcards are also supported: i.e. using Path To Folder/*.txt kann so z. B. nach Textdateien in einem bestimmtern Ordner gefiltert werden it is possible to filter for text files in a specific folder.

Code Block

language	xml

<RegistryKey Root="HKCU" Key="Path to registry key" View="Default|Registry32|Registry64"  />

Das löscht den angegebenen Registrierungsschlüssel. View kann weggelassen werden (Default Registry ViewThis deletes the specified registry key. View can be omitted (default registry view).

Code Block

language	xml

<RegistryKey Root="HKCU" Key="Path to registry key" View="Default|Registry32|Registry64" Name="Valuename" />

Das löscht den angegebenen Wert in der Registry. View kann weggelassen werden This deletes the specified value in the registry. View can be omitted (Default Registry View).

AusführungszeitpunktExecution time:

Der Aufräumprozess wird ausgeführt:

wenn primedocs deinstalliert wird.
wenn primedocs mit /clean gestartet wird.
durch manuelles Starten im Vorlageneditor.
oder beim Wechseln oder Zurücksetzen der Datenquelle.

Panel

panelIconId	atlassian-warning
panelIcon	:warning:
bgColor	#FFBDAD

ACHTUNG

Für das Aufräumen muss primedocs die Vorlage im Cache besitzen – manuelles Löschen des Caches kann dazu führen, dass verteilte Vorlagen nicht mehr automatisch entfernt werden.
Stellen Sie bei Änderungen sicher, dass auch ältere Versionen, die Sie früher ausgerollt haben, richtig aufgeräumt werden.

Beispiel

Folgende Konfiguration überprüft, dass es die richtige 32-bit bzw. 64-bit Version von einem PowerPoint AddIn registriertThe cleanup process is executed:

when OneOffixx is uninstalled.
when OneOffixx is started with /clean.
by starting it manually in the template editor.
or when changing or resetting the data source.

Note

CAUTION

For cleanup OneOffixx must have the template in cache – manually clearing the cache may prevent distributed templates from being removed automatically.
For changes, make sure that older versions you rolled out earlier are also cleaned up properly.

...

Example

The following configuration verifies that it registers the correct 32-bit or 64-bit version of a PowerPoint add-in:

Code Block

language	xml

<Configuration>
  <If Condition="oo.PowerPoint.Version == 15">
    <Path>%APPDATA%\SomePowerpointAddin</Path>
    <If Condition="oo.PowerPoint.Is32Bit">
      <Registry>
        <RegistryKey Root="HKCU" View="Registry32" Key="Software\Microsoft\Office\15.0\PowerPoint\AddIns\SomePowerpointAddin">
          <RegistryValue Type="String" Name="Path" Expand="true">%APPDATA%\SomePowerpointAddin\SomePowerpointAddin.ppam</RegistryValue>
          <RegistryValue Type="DWord" Name="AutoLoad">00000001</RegistryValue>
        </RegistryKey>
      </Registry>
      <Cleanup>
        <File Path="%APPDATA%\SomePowerpointAddin" />
        <RegistryKey Root="HKCU" View="Registry32" Key="Software\Microsoft\Office\15.0\PowerPoint\AddIns\SomePowerpointAddin" />
      </Cleanup>
    </If>
    <If Condition="oo.PowerPoint.Is64Bit">
      <Registry>
        <RegistryKey Root="HKCU" View="Registry64" Key="Software\Microsoft\Office\15.0\PowerPoint\AddIns\SomePowerpointAddin">
          <RegistryValue Type="String" Name="Path" Expand="true">%APPDATA%\SomePowerpointAddin\SomePowerpointAddin.ppam</RegistryValue>
          <RegistryValue Type="DWord" Name="AutoLoad">00000001</RegistryValue>
        </RegistryKey>
      </Registry>
      <Cleanup>
        <File Path="%APPDATA%\SomePowerpointAddin" />
        <RegistryKey Root="HKCU" View="Registry64" Key="Software\Microsoft\Office\15.0\PowerPoint\AddIns\SomePowerpointAddin" />
      </Cleanup>
    </If>
  </If>
</Configuration>

ergibt mit with API Object: oo.PowerPoint.Version = 15, oo.PowerPoint.Is32Bit = true und and oo.PowerPoint.Is64Bit = false folgendes Resultat results in the following:

Code Block

language	xml

<Configuration>
  <Path>%APPDATA%\SomePowerpointAddin</Path>
  <Registry>
    <RegistryKey Root="HKCU" View="Registry32" Key="Software\Microsoft\Office\15.0\PowerPoint\AddIns\SomePowerpointAddin">
      <RegistryValue Type="String" Name="Path" Expand="true">%APPDATA%\SomePowerpointAddin\SomePowerpointAddin.ppam</RegistryValue>
      <RegistryValue Type="DWord" Name="AutoLoad">00000001</RegistryValue>
    </RegistryKey>
  </Registry>
  <Cleanup>
    <File Path="%APPDATA%\SomePowerpointAddin" />
    <RegistryKey Root="HKCU" View="Registry32" Key="Software\Microsoft\Office\15.0\PowerPoint\AddIns\SomePowerpointAddin" />
  </Cleanup>
</Configuration>

...

Mail Theme

...

for Outlook

Panelnote

panelIconId	atlassian-warning
panelIcon	:warning:
bgColor	#FFBDAD

ACHTUNG

Der Style-Name und der .dotx-Dateiname müssen übereinstimmen.

...

CAUTION
The style name and the .dotx file name must match.

To roll out a Mail Theme via the document function, the following configuration is necessary:

Code Block

language	xml

<?xml version="1.0" encoding="utf-8"?>
<Configuration SourceTemplateDocumentType="Zip">
  <UpdateMode>ViaFiles</UpdateMode>
  <Files>
    <File Source="*.dotx" Target="%APPDATA%\Microsoft\QuickStyles\CompanyStyle.dotx" />
    <File Target="%APPDATA%\Microsoft\QuickStyles\OneOffixxTheme.config">CompanyStyle</File>
  </Files>
  <Registry>
    <RegistryFile>mailsettings.reg</RegistryFile>
  </Registry>
</Configuration>

Das Mail-Theme ist immer abhängig von der installierten Outlook Version. Möchte man zwei verschiedene Outlook-Versionen unterstützen, muss das Mail Theme dupliziert und in der entsprechenden Outlook Version angepasst werdenThe mail theme is always dependent on the installed Outlook version. If you want to support two different Outlook versions, you have to duplicate the Mail Theme and customize it in the corresponding Outlook version.

...

PowerPoint

HINWEISNOTE
Die The .ppam -Datei muss gezippt als "Fremdvorlage" importiert werden.

...

file must be imported zipped as "External template”.

To roll out the OneOffixx PowerPoint Add-in, the following configuration is necessary:

Code Block

language	xml

<Configuration>
  
  <Path>%APPDATA%\OneOffixx\PowerPoint</Path>
  <LockFile>%APPDATA%\OneOffixx\PowerPoint\OneOffixx.ppam</LockFile>
  
  <!-- Office 2016/2019 -->
  <If Condition="oo.PowerPoint.Version >= 16">
    <If Condition="oo.PowerPoint.Is32Bit">
      <Registry>
        <RegistryKey Action="CreateAndUpdate" Root="HKCU" View="Registry32" Key="Software\Microsoft\Office\16.0\PowerPoint\AddIns\OneOffixx">
          <RegistryValue Type="String" Name="Path" Expand="true">%APPDATA%\OneOffixx\PowerPoint\OneOffixx.ppam</RegistryValue>
          <RegistryValue Type="DWord" Name="AutoLoad">00000001</RegistryValue>
        </RegistryKey>
      </Registry>
      <Cleanup>
        <File Path="%APPDATA%\OneOffixx\PowerPoint" />
        <RegistryKey Root="HKCU" View="Registry32" Key="Software\Microsoft\Office\16.0\PowerPoint\AddIns\OneOffixx" />
      </Cleanup>
    </If>
    <If Condition="oo.PowerPoint.Is64Bit">
      <Registry>
        <RegistryKey Action="CreateAndUpdate" Root="HKCU" View="Registry64" Key="Software\Microsoft\Office\16.0\PowerPoint\AddIns\OneOffixx">
          <RegistryValue Type="String" Name="Path" Expand="true">%APPDATA%\OneOffixx\PowerPoint\OneOffixx.ppam</RegistryValue>
          <RegistryValue Type="DWord" Name="AutoLoad">00000001</RegistryValue>
        </RegistryKey>
      </Registry>
      <Cleanup>
        <File Path="%APPDATA%\OneOffixx\PowerPoint" />
        <RegistryKey Root="HKCU" View="Registry64" Key="Software\Microsoft\Office\16.0\PowerPoint\AddIns\OneOffixx" />
      </Cleanup>
    </If>
  </If>
  <!-- Office 2013 -->
  <If Condition="oo.PowerPoint.Version == 15">
    <If Condition="oo.PowerPoint.Is32Bit">
      <Registry>
        <RegistryKey Action="CreateAndUpdate" Root="HKCU" View="Registry32" Key="Software\Microsoft\Office\15.0\PowerPoint\AddIns\OneOffixx">
          <RegistryValue Type="String" Name="Path" Expand="true">%APPDATA%\OneOffixx\PowerPoint\OneOffixx.ppam</RegistryValue>
          <RegistryValue Type="DWord" Name="AutoLoad">00000001</RegistryValue>
        </RegistryKey>
      </Registry>
      <Cleanup>
        <File Path="%APPDATA%\OneOffixx\PowerPoint" />
        <RegistryKey Root="HKCU" View="Registry32" Key="Software\Microsoft\Office\15.0\PowerPoint\AddIns\OneOffixx" />
      </Cleanup>
    </If>
    <If Condition="oo.PowerPoint.Is64Bit">
      <Registry>
        <RegistryKey Action="CreateAndUpdate" Root="HKCU" View="Registry64" Key="Software\Microsoft\Office\15.0\PowerPoint\AddIns\OneOffixx">
          <RegistryValue Type="String" Name="Path" Expand="true">%APPDATA%\OneOffixx\PowerPoint\OneOffixx.ppam</RegistryValue>
          <RegistryValue Type="DWord" Name="AutoLoad">00000001</RegistryValue>
        </RegistryKey>
      </Registry>
      <Cleanup>
        <File Path="%APPDATA%\OneOffixx\PowerPoint" />
        <RegistryKey Root="HKCU" View="Registry64" Key="Software\Microsoft\Office\15.0\PowerPoint\AddIns\OneOffixx" />
      </Cleanup>
    </If>
  </If>
  <!-- Office 2010 -->
  <If Condition="oo.PowerPoint.Version == 14">
     <If Condition="oo.PowerPoint.Is32Bit">
      <Registry>
        <RegistryKey Action="CreateAndUpdate" Root="HKCU" View="Registry32" Key="Software\Microsoft\Office\14.0\PowerPoint\AddIns\OneOffixx">
          <RegistryValue Type="String" Name="Path" Expand="true">%APPDATA%\OneOffixx\PowerPoint\OneOffixx_O2010.ppam</RegistryValue>
          <RegistryValue Type="DWord" Name="AutoLoad">00000001</RegistryValue>
        </RegistryKey>
      </Registry>
      <Cleanup>
        <File Path="%APPDATA%\OneOffixx\PowerPoint" />
        <RegistryKey Root="HKCU" View="Registry32" Key="Software\Microsoft\Office\14.0\PowerPoint\AddIns\OneOffixx" />
      </Cleanup>
    </If>
    <If Condition="oo.PowerPoint.Is64Bit">
      <Registry>
        <RegistryKey Action="CreateAndUpdate" Root="HKCU" View="Registry64" Key="Software\Microsoft\Office\14.0\PowerPoint\AddIns\OneOffixx">
          <RegistryValue Type="String" Name="Path" Expand="true">%APPDATA%\OneOffixx\PowerPoint\OneOffixx_O2010.ppam</RegistryValue>
          <RegistryValue Type="DWord" Name="AutoLoad">00000001</RegistryValue>
        </RegistryKey>
      </Registry>
      <Cleanup>
        <File Path="%APPDATA%\OneOffixx\PowerPoint" />
        <RegistryKey Root="HKCU" View="Registry64" Key="Software\Microsoft\Office\14.0\PowerPoint\AddIns\OneOffixx" />
      </Cleanup>
    </If>
  </If>
</Configuration>

...

Excel

HINWEISNOTE
Die The .xlam -Datei muss gezippt als "Fremdvorlage" importiert werden.

...

file must be imported zipped as "External template”.

To roll out the OneOffixx Excel add-in, the following configuration is necessary:

Code Block

language	xml

<Configuration>
  <Path>%APPDATA%\OneOffixx\Excel</Path>
  <LockFile>%APPDATA%\OneOffixx\Excel\OneOffixx.xlam</LockFile>
  <Shortcut>%APPDATA%\Microsoft\Excel\XLSTART\</Shortcut>
  <Cleanup>
    <File Path="%APPDATA%\OneOffixx\Excel" />
    <File Path="%APPDATA%\Microsoft\Excel\XLSTART\OneOffixx.lnk" />
  </Cleanup>
</Configuration>

...

Versions Compared

Old Version 1

New Version Current

Key

"Scriptable"

Cleanup

Beispiel

Example

Mail Theme

for Outlook

PowerPoint

Excel

Page Comparison

Versions Compared

Old Version 1

New Version Current

Key

"Scriptable"

Cleanup

Beispiel

Example

Mail Theme

for Outlook

PowerPoint

Excel