Skip to main content
Version: 4.2 (2027 H1)

OneOffixx Connect (legacy format)

Besides primedocs Connect, primedocs still understands the older XML format OneOffixx Connect with the root element <OneOffixxConnectBatch>. Existing integrations, for example from a GEVER system, therefore keep working unchanged. New integrations use primedocs Connect.

Processing​

  • Client side: primedocs Desktop processes a OneOffixx Connect file like a Connect file, for example via the protocol handler with connector=. New documents and updating existing documents are both possible.
  • Server side: The Connect server application accepts OneOffixx Connect XML and returns the generated document. It is marked as obsolete and only creates new documents. If a call contains no entry that creates a new document (editor mode does not count either), it responds with HTTP 400. For new server-side integrations use the Connect API.

Structure​

<?xml version="1.0" encoding="utf-8"?>
<OneOffixxConnectBatch>
  <Entries>
    <OneOffixxConnect>
      <Arguments>
        <TemplateId>6f1c2b1e-0000-4000-8000-000000000001</TemplateId>
        <LanguageLcid>2055</LanguageLcid>
      </Arguments>
      <primedocsConnectBridge>
        <Forms>
          <Value Key="Subject">Quote no. 2026-0815</Value>
        </Forms>
        <Data>
          <Value Key="CaseNumber">2026-0815</Value>
        </Data>
      </primedocsConnectBridge>
    </OneOffixxConnect>
  </Entries>
</OneOffixxConnectBatch>

Under <Arguments> the template is given as <TemplateId> or as <TemplateFilter> with one or more <Tag> elements, an existing document as <DocumentLocation>. Further arguments include LanguageLcid, ProfileId and Organization.

Web-capable templates and primedocsConnectBridge​

OneOffixx Connect can also create web-capable templates. Their form and data values are placed in the <primedocsConnectBridge> element, with the same elements as Forms and Data in primedocs Connect: Value, Object and ObjectCollection, each with the Key attribute.

The result of a web-capable template is a document, not a template file. primedocs Desktop creates it as .docx, .xlsx or .pptx, just as when creating from primedocs. Whether it is then opened depends on the commands, see Opening a document with DefaultProcess. The server application returns it under its document name, without a name as result.docx, result.xlsx or result.pptx. Neither the AutoConvertToDocument setting nor the ConvertToDocument command is needed for this. Only in the editor mode of primedocs Desktop does the result stay a template (.dotx, .xltx or .potx). Classic templates keep their previous behaviour.

Opening a document with DefaultProcess​

In primedocs Desktop, DefaultProcess with Start=true opens the document. An explicitly specified <Command Name="DefaultProcess" /> without Start, or with Start=false, performs no action. This does not prevent document creation. This command does not open the document.

For new documents, primedocs automatically adds DefaultProcess with Start=true if the entry contains no DefaultProcess and the batch contains no commands of its own. This also applies when the entry contains other commands. An existing DefaultProcess does not receive a Start parameter.

To open the document explicitly, insert the following block as a child of <OneOffixxConnect>, alongside <Arguments> and <primedocsConnectBridge>:

<Commands>
  <Command Name="DefaultProcess">
    <Parameters>
      <Add key="Start">true</Add>
    </Parameters>
  </Command>
</Commands>

Updating an existing document​

If <Arguments> contains a non-empty <DocumentLocation>, primedocs updates the document at that location. This also applies if <TemplateId> or <TemplateFilter> is set as well. A new document is only created without <DocumentLocation>. This matches the behaviour of primedocs Connect, see Updating documents.

If neither the entry nor the batch contains commands, primedocs automatically adds SaveAs targeting DocumentLocation, followed by DefaultProcess with Start=true, when updating the document. In primedocs Desktop, this saves the document at the same location and opens it. If the document was created from a web-capable template, primedocs applies the values from <primedocsConnectBridge>. Values that are not supplied are kept, see Supplied and omitted values.