<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom">
  <channel>
    <title>Integration on speedata Publisher</title>
    <link>/en/manual/integration/</link>
    <description>Recent content in Integration on speedata Publisher</description>
    <generator>Hugo</generator>
    <language>en</language>
    <atom:link href="/en/manual/integration/index.xml" rel="self" type="application/rss+xml" />
    <item>
      <title>Lua-Filter / pre-processing</title>
      <link>/en/manual/integration/preprocessing/</link>
      <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
      <guid>/en/manual/integration/preprocessing/</guid>
      <description>&lt;p&gt;Sometimes you may want to convert the data into another format or check for correctness before the actual PDF creation.&#xA;For this purpose there is the possibility (since version 3.1.9) to execute a Lua script before the actual publishing run.&#xA;Lua is a simple but powerful programming language that is intended to be built into other programs as a scripting language.&lt;/p&gt;&#xA;&lt;p&gt;Three use cases can be found in &lt;a href=&#34;https://github.com/speedata/examples/tree/master/technical&#34; target=&#34;_blank&#34; rel=&#34;noreferrer&#34;&gt;examples repository&lt;/a&gt;.&lt;/p&gt;&#xA;&lt;div class=&#34;admonitionblock&#34;&gt;&#xA;  &lt;table&gt;&lt;tbody&gt;&lt;tr&gt;&#xA;    &lt;td class=&#34;icon&#34;&gt;&lt;svg height=&#34;1.5em&#34; xmlns=&#34;http://www.w3.org/2000/svg&#34; fill=&#34;none&#34; viewBox=&#34;0 0 24 24&#34; stroke-width=&#34;2&#34; stroke=&#34;currentColor&#34; aria-hidden=&#34;true&#34;&gt;&lt;path stroke-linecap=&#34;round&#34; stroke-linejoin=&#34;round&#34; d=&#34;M9.663 17h4.673M12 3v1m6.364 1.636l-.707.707M21 12h-1M4 12H3m3.343-5.657l-.707-.707m2.828 9.9a5 5 0 117.072 0l-.548.547A3.374 3.374 0 0014 18.469V19a2 2 0 11-4 0v-.531c0-.895-.356-1.754-.988-2.386l-.548-.547z&#34;/&gt;&lt;/svg&gt;&lt;/td&gt;&#xA;    &lt;td class=&#34;content&#34;&gt;Since version 5.5.14 the filter pre-processing runs on Lua 5.4 (previously Lua 5.1). Scripts that use &lt;code&gt;setfenv&lt;/code&gt;/&lt;code&gt;getfenv&lt;/code&gt;, &lt;code&gt;unpack(...)&lt;/code&gt; (instead of &lt;code&gt;table.unpack&lt;/code&gt;), &lt;code&gt;loadstring&lt;/code&gt; or &lt;code&gt;module(...)&lt;/code&gt; need to be adjusted accordingly.&lt;/td&gt;&#xA;  &lt;/tr&gt;&lt;/tbody&gt;&lt;/table&gt;&#xA;&lt;/div&gt;&#xA;&#xA;&lt;h2&gt;Calling the Lua script&lt;span id=&#34;calling-the-lua-script&#34; style=&#34;position:absolute;margin-top:-5rem;&#34;&gt;&lt;/span&gt;&#xA;    &lt;a href=&#34;#calling-the-lua-script&#34; class=&#34;heading-anchor&#34; aria-hidden=&#34;true&#34;&gt;&lt;/a&gt;&lt;/h2&gt;&#xA;&lt;p&gt;The filter is started either via the command line&lt;/p&gt;</description>
    </item>
    <item>
      <title>Server mode (REST API)</title>
      <link>/en/manual/integration/servermode/</link>
      <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
      <guid>/en/manual/integration/servermode/</guid>
      <description>&lt;a href=&#34;https://www.speedata.de/en/prices/&#34; class=&#34;prolink&#34; data-tooltip=&#34;Available in the Pro plan&#34; data-flow=&#34;top&#34;&gt;PRO&lt;/a&gt;&#xA;&lt;p&gt;The Publisher provides an interface that can be used to pass requests for document generation via HTTP. The server mode is started with&lt;/p&gt;&#xA;&lt;pre tabindex=&#34;0&#34;&gt;&lt;code&gt;sp server&#xA;&lt;/code&gt;&lt;/pre&gt;&lt;p&gt;on the command line. The server mode offers the option to&lt;/p&gt;&#xA;&lt;ul&gt;&#xA;&lt;li&gt;transfer data to the server and start a run&lt;/li&gt;&#xA;&lt;li&gt;determine status of the run (is the process still running?)&lt;/li&gt;&#xA;&lt;li&gt;download finished PDF files&lt;/li&gt;&#xA;&lt;li&gt;retrieve protocol and other files from the working directory&lt;/li&gt;&#xA;&lt;/ul&gt;&#xA;&lt;div class=&#34;admonitionblock&#34;&gt;&#xA;  &lt;table&gt;&lt;tbody&gt;&lt;tr&gt;&#xA;    &lt;td class=&#34;icon&#34;&gt;&lt;svg height=&#34;1.5em&#34; xmlns=&#34;http://www.w3.org/2000/svg&#34; fill=&#34;none&#34; viewBox=&#34;0 0 24 24&#34; stroke-width=&#34;2&#34; stroke=&#34;currentColor&#34; aria-hidden=&#34;true&#34;&gt;&lt;path stroke-linecap=&#34;round&#34; stroke-linejoin=&#34;round&#34; d=&#34;M12 9v2m0 4h.01m-6.938 4h13.856c1.54 0 2.502-1.667 1.732-3L13.732 4c-.77-1.333-2.694-1.333-3.464 0L3.34 16c-.77 1.333.192 3 1.732 3z&#34;/&gt;&lt;/svg&gt;&lt;/td&gt;&#xA;    &lt;td class=&#34;content&#34;&gt;Server mode is intended for a non-public environment. There are no authentication methods and no mechanisms to protect documents.&lt;/td&gt;&#xA;  &lt;/tr&gt;&lt;/tbody&gt;&lt;/table&gt;&#xA;&lt;/div&gt;&#xA;&#xA;&lt;div class=&#34;admonitionblock&#34;&gt;&#xA;  &lt;table&gt;&lt;tbody&gt;&lt;tr&gt;&#xA;    &lt;td class=&#34;icon&#34;&gt;&lt;svg height=&#34;1.5em&#34; xmlns=&#34;http://www.w3.org/2000/svg&#34; fill=&#34;none&#34; viewBox=&#34;0 0 24 24&#34; stroke-width=&#34;2&#34; stroke=&#34;currentColor&#34; aria-hidden=&#34;true&#34;&gt;&lt;path stroke-linecap=&#34;round&#34; stroke-linejoin=&#34;round&#34; d=&#34;M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z&#34;/&gt;&lt;/svg&gt;&lt;/td&gt;&#xA;    &lt;td class=&#34;content&#34;&gt;API version 0 (&lt;code&gt;/v0/...&lt;/code&gt;) is still available but no longer actively developed.&#xA;New integrations should use API version 1 (&lt;code&gt;/v1/...&lt;/code&gt;).&lt;/td&gt;&#xA;  &lt;/tr&gt;&lt;/tbody&gt;&lt;/table&gt;&#xA;&lt;/div&gt;&#xA;&#xA;&lt;p&gt;The server establishes the connection on the IP address &lt;code&gt;127.0.0.1&lt;/code&gt; and port &lt;code&gt;5266&lt;/code&gt;.&#xA;The address can be changed with the parameters &lt;code&gt;address&lt;/code&gt; and &lt;code&gt;port&lt;/code&gt; in the configuration file or on the command line, see &lt;a href=&#34;/en/reference/configuration/&#34;&gt;the appendix about configuration&lt;/a&gt;.&lt;/p&gt;</description>
    </item>
    <item>
      <title>Starting the Publisher via the Hotfolder</title>
      <link>/en/manual/integration/hotfolder/</link>
      <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
      <guid>/en/manual/integration/hotfolder/</guid>
      <description>&lt;p&gt;The speedata Publisher can monitor a directory as a “watchdog” in order to start automatically when changes are made.&#xA;Such a directory is also called hotfolder.&#xA;You can specify rules about what happens when a certain file is written to this directory.&lt;/p&gt;&#xA;&lt;div class=&#34;admonitionblock&#34;&gt;&#xA;  &lt;table&gt;&lt;tbody&gt;&lt;tr&gt;&#xA;    &lt;td class=&#34;icon&#34;&gt;&lt;svg height=&#34;1.5em&#34; xmlns=&#34;http://www.w3.org/2000/svg&#34; fill=&#34;none&#34; viewBox=&#34;0 0 24 24&#34; stroke-width=&#34;2&#34; stroke=&#34;currentColor&#34; aria-hidden=&#34;true&#34;&gt;&lt;path stroke-linecap=&#34;round&#34; stroke-linejoin=&#34;round&#34; d=&#34;M12 9v2m0 4h.01m-6.938 4h13.856c1.54 0 2.502-1.667 1.732-3L13.732 4c-.77-1.333-2.694-1.333-3.464 0L3.34 16c-.77 1.333.192 3 1.732 3z&#34;/&gt;&lt;/svg&gt;&lt;/td&gt;&#xA;    &lt;td class=&#34;content&#34;&gt;The Publisher deletes the XML file from the directory as soon as it is processed.&lt;/td&gt;&#xA;  &lt;/tr&gt;&lt;/tbody&gt;&lt;/table&gt;&#xA;&lt;/div&gt;&#xA;&#xA;&lt;p&gt;The hotfolder is configured in the same way as the Publisher using the publisher.cfg file.&lt;/p&gt;</description>
    </item>
    <item>
      <title>Lua callbacks</title>
      <link>/en/manual/integration/luacallbacks/</link>
      <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
      <guid>/en/manual/integration/luacallbacks/</guid>
      <description>&lt;p&gt;Some parts of the publishing run can be customized with Lua functions: the file lookup and the conversion of images with external programs.&#xA;For this purpose a Lua file is given with the configuration setting &lt;code&gt;luafile&lt;/code&gt; (or on the command line with &lt;code&gt;--luafile&lt;/code&gt;), for example:&lt;/p&gt;&#xA;&lt;pre tabindex=&#34;0&#34;&gt;&lt;code&gt;luafile = hooks.lua&#xA;&lt;/code&gt;&lt;/pre&gt;&lt;p&gt;The file is loaded at the beginning of the publishing run, before the layout and data files are opened.&#xA;It registers functions for fixed callback names with &lt;code&gt;register_callback()&lt;/code&gt;:&lt;/p&gt;</description>
    </item>
    <item>
      <title>Publisher Webservice API</title>
      <link>/en/manual/integration/saasapi/</link>
      <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
      <guid>/en/manual/integration/saasapi/</guid>
      <description>&lt;a href=&#34;https://www.speedata.de/en/prices/&#34; class=&#34;prolink&#34; data-tooltip=&#34;Available in the Pro plan&#34; data-flow=&#34;top&#34;&gt;PRO&lt;/a&gt;&#xA;&lt;p&gt;The speedata Publisher can be used without local installation.&#xA;For this purpose, a so-called Software-as-a-Service solution is available at &lt;a href=&#34;https://api.speedata.de&#34; target=&#34;_blank&#34; rel=&#34;noreferrer&#34;&gt;https://api.speedata.de&lt;/a&gt;, which can be used via a REST interface.&lt;/p&gt;&#xA;&lt;p&gt;In order to access the speedata Publisher API, a valid Pro plan must be available and an API key (token) must be generated in the download area. This key can then be used to access all functions.&lt;/p&gt;</description>
    </item>
    <item>
      <title>File attachments</title>
      <link>/en/manual/integration/attachments/</link>
      <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
      <guid>/en/manual/integration/attachments/</guid>
      <description>&lt;p&gt;The PDF file format offers the possibility of embedding files in the document so that they can then be downloaded as stand-alone documents. Electronic invoices, for example, can be sent as a “human-readable” PDF with an attached computer-readable description (as XML).&lt;/p&gt;&#xA;&lt;p&gt;Any number of files can be attached, but only one ZUGFeRD invoice.&lt;/p&gt;&#xA;&lt;h2&gt;Attach files&lt;span id=&#34;attach-files&#34; style=&#34;position:absolute;margin-top:-5rem;&#34;&gt;&lt;/span&gt;&#xA;    &lt;a href=&#34;#attach-files&#34; class=&#34;heading-anchor&#34; aria-hidden=&#34;true&#34;&gt;&lt;/a&gt;&lt;/h2&gt;&#xA;&lt;div class=&#34;highlight&#34;&gt;&lt;pre tabindex=&#34;0&#34; class=&#34;chroma&#34;&gt;&lt;code class=&#34;language-xml&#34; data-lang=&#34;xml&#34;&gt;&lt;span class=&#34;line&#34;&gt;&lt;span class=&#34;cl&#34;&gt;&lt;span class=&#34;nt&#34;&gt;&amp;lt;AttachFile&lt;/span&gt; &lt;span class=&#34;na&#34;&gt;description=&lt;/span&gt;&lt;span class=&#34;s&#34;&gt;&amp;#34;A nice view&amp;#34;&lt;/span&gt;&#xA;&lt;/span&gt;&lt;/span&gt;&lt;span class=&#34;line&#34;&gt;&lt;span class=&#34;cl&#34;&gt;            &lt;span class=&#34;na&#34;&gt;type=&lt;/span&gt;&lt;span class=&#34;s&#34;&gt;&amp;#34;application/pdf&amp;#34;&lt;/span&gt;&#xA;&lt;/span&gt;&lt;/span&gt;&lt;span class=&#34;line&#34;&gt;&lt;span class=&#34;cl&#34;&gt;            &lt;span class=&#34;na&#34;&gt;filename=&lt;/span&gt;&lt;span class=&#34;s&#34;&gt;&amp;#34;ocean.pdf&amp;#34;&lt;/span&gt; &lt;span class=&#34;nt&#34;&gt;/&amp;gt;&lt;/span&gt;&#xA;&lt;/span&gt;&lt;/span&gt;&lt;/code&gt;&lt;/pre&gt;&lt;/div&gt;&lt;p&gt;This command is used to attach a file to the PDF. The type is the &lt;a href=&#34;https://en.wikipedia.org/wiki/Media_type&#34; target=&#34;_blank&#34; rel=&#34;noreferrer&#34;&gt;mime type&lt;/a&gt; of the attached file.&lt;/p&gt;</description>
    </item>
    <item>
      <title>Accessibility / tagged PDF</title>
      <link>/en/manual/integration/accessibility/</link>
      <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
      <guid>/en/manual/integration/accessibility/</guid>
      <description>&lt;h2&gt;What is tagged PDF?&lt;span id=&#34;what-is-tagged-pdf&#34; style=&#34;position:absolute;margin-top:-5rem;&#34;&gt;&lt;/span&gt;&#xA;    &lt;a href=&#34;#what-is-tagged-pdf&#34; class=&#34;heading-anchor&#34; aria-hidden=&#34;true&#34;&gt;&lt;/a&gt;&lt;/h2&gt;&#xA;&lt;p&gt;Tagged PDF is an extension of the PDF file with a logical structure of the content. The tags are used to determine the role of the object to be output, e.g. level 1 heading, a paragraph or an image. This is mainly used to create accessible PDFs, i.e. PDFs that are optimized for screen readers or similar output devices.&lt;/p&gt;&#xA;&lt;p&gt;For accessible PDFs, not only the technical side must be taken into account (this is what the speedata Publisher is for), but also the logical structure must be created sensibly. For example, images must be output with an alternative text, otherwise their use is restricted.&lt;/p&gt;</description>
    </item>
  </channel>
</rss>
