Automatisierung 3 Min. Lesezeit

PaperOffice Fernsteuerung

Commandline API


Funktion

Befehle an PaperOffice über CMD entgegennehmen Beschreibung


Beschreibung

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.


Funktionsprinzip

Führen Sie "C:\PaperOffice\com.paperoffice.launcher.exe" vom Terminal mit den gewünschten Argumentparametern aus.

Die Argumentstruktur lautet wie folgt: "main_command=command sub_command=value" und fängt immer mit "useapi=1" an
Beispiel:

useapi=1 command=open_document document_id=42

Terminal

POJOB-JSON Datei

Alternativ können Sie die Argumente zu einer JSON-Objektdatei hinzufügen und unter "shellpipe_filename.json" im Root-Installationsordner von PaperOffice speichern.
PaperOffice überwacht den internen Ordner auf Dateien, welche die Dateinamen "shellpipe_filename.json" haben und verarbeitet die darin befindlichen API-Befehle.

Das Argument "useapi=1" wird in der json-Datei nicht benötigt.

Beispiel:

{
    "command":"open_document",
    "document_id":42
}

Suche

Verwendung:
useapi=1 command=search searchfor="text to search"
Command Type Beschreibung
search String Main command
searchfor String Sub command
Text to search
CMD Example:
c:\>C:\PaperOffice\com.paperoffice.launcher.exe useapi=1 command=search searchfor="Invoice 12345"
JSON File Beispiel: 
{
    "command":"search",
    "searchfor":"Invoice 12345"
}

Dokument öffnen

Das Öffnen von Dokumenten kann auf zwei verschiedene Arten erfolgen.
  • Durch direkte Eingabe der Dokument-ID.
    Verwendung:
    useapi=1 command=open_document document_id=ID
    Command Type Beschreibung
    open_document String
    		 Main command
    document_id Integer Sub command
    Example:
    c:\>C:\PaperOffice\com.paperoffice.launcher.exe useapi=1 command=open_document document_id=42
    JSON File Beispiel: 
    {
    "command":"open_document",
    "document_id":42
}
  • Durch eine Suche nach einem bestimmten Feldwert.
    Verwendung:
    useapi=1 command=open_document name=field_name value=text to search
    Durch Öffnen eines Dokuments über eine Suche wird das Dokument ab dem ersten Suchtreffer geöffnet!
    Advice: Sie können nach Werten suchen, indem Sie den Platzhalter "%" zusammen mit dem Argument "querymode = LIKE" verwenden: querymode=LIKE value="%text_to_search%"
    Command Type Beschreibung
    open_document String
    		 Main command
    name String Sub command
    Field name to search
    value String Text to search
    querymode=LIKE String Optional
    Use when searching with "%" wildcard
    Example:
    c:\>C:\PaperOffice\com.paperoffice.launcher.exe useapi=1 command=open_document name=voucher_number querymode=LIKE value="%123456%"
    JSON File Beispiel: 
    {
    "command":"open_document",
    "name":"voucher_number",
    "querymode":"LIKE",
    "value":"%123456%"
}

Ordner öffnen

Verwendung:
useapi=1 command=open_folder category_id=ID
Command Type Beschreibung
open_folder String Main command
category_id Integer Sub command
Folder ID to open
Beispiele:
c:\>C:\PaperOffice\com.paperoffice.launcher.exe useapi=1 command=open_folder category_id=639
JSON File Beispiele: 
{
"command":"open_folder",
"category_id":639
}