PaperOffice Fernsteuerung

<h3 class="uk-heading-divider"><small class="fas fa-terminal"></small> Commandline API</h3> <br> <p> <h4>Funktion</h4> <div> Befehle an PaperOffice über CMD entgegennehmen Beschreibung </div>
</p> <br> <p> <h4>Beschreibung</h4> <div> PaperOffice nimmt Befehle über die Kommandozeile an, erstellt automatisch eine POAPI-JSON Datei und führt die Befehle darin aus. Die Variablen sind identisch mit dem Aufbau der POAPI-JSON. </div>
</p> <br> <h4>Funktionsprinzip</h4> <div>

<p> Führen Sie "C:\PaperOffice\com.paperoffice.launcher.exe" vom Terminal mit den gewünschten Argumentparametern aus. </p> <p> Die Argumentstruktur lautet wie folgt: "<i>main_command</i>=<i>command</i> <i>sub_command</i>=<i>value</i>" und fängt immer mit "useapi=1" an<br> Beispiel:<div class="cm">useapi=1 command=open_document document_id=42</div> <br> <img src="https://api.paperoffice.ai/latest/knowledge/image/15/9019d562a0a632b68943011b31981e5d15fa306d31eaccda0de3cd201eefbec5" alt="Terminal"> </p> </div>

<h4 class="uk-heading-divider"><small class="fas fa-terminal"></small> POJOB-JSON Datei</h4>

<div> <p> Alternativ können Sie die Argumente zu einer JSON-Objektdatei hinzufügen und unter "<b>shellpipe<i>filename</i>.json</b>" im Root-Installationsordner von PaperOffice speichern.<br> PaperOffice überwacht den internen Ordner auf Dateien, welche die Dateinamen "shellpipe<i>filename</i>.json" haben und verarbeitet die darin befindlichen API-Befehle. </p> <p class="remark yellow"> Das Argument "useapi=1" wird in der json-Datei nicht benötigt. </p> <p> <b>Beispiel:</b><br> <pre class="jsf"> { "command":"open_document", "document_id":42 } </pre> </p>

</div>

<hr>

<h4>Suche</h4> Verwendung: <div class="cm">useapi=1 command=<i>search</i> searchfor=<i>"text to search"</i></div> <table class="uk-table uk-table-striped apitd"> <tr> <th>Command</th> <th>Type</th> <th>Beschreibung</th> </tr> <tr> <td>search</td> <td>String</td> <td>Main command</td> </tr> <tr> <td>searchfor</td> <td>String</td> <td>Sub command<br><small>Text to search</small></td> </tr> <tr> <td colspan="3"> CMD Example: <div class="cm">c:>C:\PaperOffice\com.paperoffice.launcher.exe useapi=1 command=search searchfor="Invoice 12345"</div> </td> </tr> <tr> <td colspan="3"> JSON File Beispiel: <pre class="jsf"> { "command":"search", "searchfor":"Invoice 12345" } </pre> </td> </tr> </table>

<hr>

<h4>Dokument öffnen</h4> Das Öffnen von Dokumenten kann auf zwei verschiedene Arten erfolgen. <ul> <li> <b>Durch direkte Eingabe der Dokument-ID.</b><br> Verwendung: <div class="cm">useapi=1 command=<i>open_document</i> document_id=<i>ID</i></div> <table class="uk-table uk-table-striped apitd"> <tr> <th>Command</th> <th>Type</th> <th>Beschreibung</th> </tr> <tr> <td>open_document</td> <td>String<br></td> <td>Main command</td> </tr> <tr> <td>document_id</td> <td>Integer</td> <td>Sub command</td> </tr> <tr> <td colspan="3"> Example: <div class="cm">c:>C:\PaperOffice\com.paperoffice.launcher.exe useapi=1 command=open_document document_id=42</div> </td> </tr> <tr> <td colspan="3"> JSON File Beispiel: <pre class="jsf"> { "command":"open_document", "document_id":42 } </pre> </td> </tr> </table> </li> <li> <b>Durch eine Suche nach einem bestimmten Feldwert.</b><br> Verwendung: <div class="cm">useapi=1 command=<i>open_document</i> name=<i>field_name</i> value=<i>text to search</i></div> <div class="remark yellow">
Durch Öffnen eines Dokuments über eine Suche wird das Dokument ab dem ersten Suchtreffer geöffnet! </div> <div class="remark success">
<b>Advice:</b> Sie können nach Werten suchen, indem Sie den Platzhalter "%" zusammen mit dem Argument "querymode = LIKE" verwenden: <code>querymode=LIKE value="%text_to_search%"</code> </div> <table class="uk-table uk-table-striped apitd"> <tr> <th>Command</th> <th>Type</th> <th>Beschreibung</th> </tr> <tr> <td>open_document</td> <td>String<br></td> <td>Main command</td> </tr> <tr> <td>name</td> <td>String</td> <td>Sub command<br><small>Field name to search</small></td> </tr> <tr> <td>value</td> <td>String</td> <td>Text to search</td> </tr> <tr> <td>querymode=LIKE</td> <td>String</td> <td>Optional<br>Use when searching with "%" wildcard</td> </tr> <tr> <td colspan="4"> Example: <div class="cm">c:>C:\PaperOffice\com.paperoffice.launcher.exe useapi=1 command=open_document name=voucher_number querymode=LIKE value="%123456%"</div> </td> </tr> <tr> <td colspan="3"> JSON File Beispiel: <pre class="jsf"> { "command":"open_document", "name":"voucher_number", "querymode":"LIKE", "value":"%123456%" } </pre> </td> </tr> </table> </li> </ul>

<hr>

<h4>Ordner öffnen </h4> Verwendung: <div class="cm">useapi=1 command=<i>open_folder</i> category_id=<i>ID</i></div> <table class="uk-table uk-table-striped apitd"> <tr> <th>Command</th> <th>Type</th> <th>Beschreibung</th> </tr> <tr> <td>open_folder</td> <td>String</td> <td>Main command</td> </tr> <tr> <td>category_id</td> <td>Integer</td> <td>Sub command<br><small>Folder ID to open</small></td> </tr> <tr> <td colspan="3"> Beispiele: <div class="cm">c:>C:\PaperOffice\com.paperoffice.launcher.exe useapi=1 command=open_folder category_id=639</div> </td> </tr> <tr> <td colspan="3"> JSON File Beispiele: <pre class="jsf"> { "command":"open_folder", "category_id":639 } </pre> </td> </tr> </table>