Benutzerdefinierte Funktionen mit Zoho Finance CLI
In Zoho Books ist die primäre Methode, um den Code einer benutzerdefinierten Funktion zu schreiben, der integrierte Deluge-Editor. Mit der Zoho Finance CLI können Sie den Code für benutzerdefinierte Funktionen in beliebten Programmiersprachen wie Java, Node.js und Python schreiben. Sobald Sie den Code geschrieben haben, können Sie ihn einfach in Zoho Books hochladen.
Einblick: Eine Befehlszeilenschnittstelle (CLI) ist eine textbasierte Benutzeroberfläche (UI), die verwendet wird, um Programme auszuführen, Computerdateien zu verwalten und mit dem Computer zu interagieren. Eingaben werden über die Eingabeaufforderung oder das Terminal an die CLI übergeben und dann vom Computer ausgeführt.
Voraussetzung: Um die Zoho Finance CLI zu verwenden, müssen Sie Node.js herunterladen. Laden Sie Node.js Version 16 auf Ihr Gerät herunter. Dies wird mit npx installiert. Nach der Installation geben Sie die folgenden Befehle ein, um zu überprüfen, ob sie ordnungsgemäß installiert wurden.
- node -v
- npx -v
Zoho Finance CLI-Befehle
Beziehen Sie sich auf die unten aufgeführten Befehle, um das Zoho Finance CLI-Toolkit zu verwenden.
- login: Melden Sie sich bei Ihrem Zoho-Konto an.
- pull: Laden Sie die in Zoho Books erstellte benutzerdefinierte Funktion auf Ihr Gerät herunter.
- execute: Führen Sie die benutzerdefinierte Funktion aus und überprüfen Sie, ob sie wie gewünscht funktioniert.
- push: Pushen Sie den Code zu Zoho Books und aktualisieren Sie die benutzerdefinierte Funktion.
- logout: Melden Sie sich von Ihrem Zoho-Konto ab.
Melden Sie sich bei Ihrem Zoho-Konto an
Sie müssen sich über das Terminal oder die Eingabeaufforderung bei Ihrem Zoho-Konto anmelden. So geht’s:
Öffnen Sie das Terminal oder die Eingabeaufforderung auf Ihrem Gerät.
Geben Sie den Befehl ein:
npx @zohofinance/cli loginWählen Sie die DC, in der Ihr Zoho-Konto erstellt wurde. Sie werden zur Anmeldeseite von Zoho Accounts weitergeleitet.
Klicken Sie auf Zulassen. Sie sind bei Ihrem Zoho-Konto angemeldet.
Laden Sie die benutzerdefinierte Funktion herunter
Sie müssen eine benutzerdefinierte Funktion erstellen in Zoho Books und sie auf Ihr Gerät herunterladen, um den erforderlichen Code über die CLI einzugeben. So geht’s:
- Öffnen Sie das Terminal oder die Eingabeaufforderung auf Ihrem Gerät.
- Geben Sie den Befehl ein:
npx @zohofinance/cli pull
"https://www.zohoapis.com/books/integrations/customfunctions/xxxxxxxxxxxxxxxxx/download?organisation_id=yyyyyyyy&entity=invoice"
Hier steht xxxx… für die ID der benutzerdefinierten Funktion und yyyy…. für die ID Ihrer Organisation. Klicken Sie auf Kopieren neben dem Befehl auf der Bearbeitungsseite der benutzerdefinierten Funktion, um die vorausgefüllte ID der benutzerdefinierten Funktion und die Organisations-ID zu verwenden.
Schreiben Sie den Code im Editor
Sie können den Code der benutzerdefinierten Funktion in einem Code-Editor schreiben. Nach dem Herunterladen einer benutzerdefinierten Funktion wird ein Ordner in Ihrem aktuellen Arbeitsverzeichnis heruntergeladen, der die erforderlichen Dateien für die benutzerdefinierte Funktion enthält.
Um den Code der benutzerdefinierten Funktion zu schreiben:
- Öffnen Sie den heruntergeladenen Ordner.
- Öffnen Sie die Datei mit der .py-, .js- oder .java-Erweiterung, basierend auf der Programmiersprache, die Sie beim Erstellen der benutzerdefinierten Funktion ausgewählt haben. Wenn der Name der benutzerdefinierten Funktion beispielsweise sample_custom_function ist und die Programmiersprache Java ist, wird die Datei sample_custom_function.java genannt.
- Geben Sie den Code der benutzerdefinierten Funktion in dieser Datei von einem Code-Editor ein und speichern Sie ihn.
Führen Sie den Code aus
Sie können den Code der benutzerdefinierten Funktion ausführen, um zu überprüfen, ob er wie beabsichtigt funktioniert. So geht’s:
- Öffnen Sie das Terminal oder die Eingabeaufforderung auf Ihrem Gerät.
- Geben Sie den Befehl ein:
npx @zohofinance/cli execute - Geben Sie die ID eines Datensatzes im Modul ein, für das Sie die benutzerdefinierte Funktion erstellt haben, im Feld Geben Sie die Entitäts-ID ein. Die Entitäts-ID ist in der URL verfügbar. Wenn Sie beispielsweise die benutzerdefinierte Funktion für das Modul Rechnungen in Zoho Books erstellt haben, wählen Sie eine Rechnung aus und kopieren Sie den Teil der URL, der nach ‘invoices/’ erscheint. Dies ist die Entitäts-ID.
Sobald die benutzerdefinierte Funktion ausgeführt wird, wird das Ergebnis angezeigt.
Pushen Sie den Code zu Zoho Books
Nachdem Sie den Code der benutzerdefinierten Funktion geschrieben und ausgeführt haben, können Sie ihn zu Zoho Books pushen, um die benutzerdefinierte Funktion in der App zu aktualisieren. So geht’s:
- Öffnen Sie das Terminal oder die Eingabeaufforderung auf Ihrem Gerät.
- Geben Sie den Befehl ein:
npx @zohofinance/cli push
Damit wird die benutzerdefinierte Funktion gepusht und in Ihrer Zoho Books-Organisation aktualisiert.
Hinweis: Benutzerdefinierte Funktionen, die mit der Zoho Finance CLI erstellt wurden, können nicht von Zoho Books aus bearbeitet werden. Sie können nur im Terminal oder in der Eingabeaufforderung bearbeitet werden. Sie können diese Funktionen jedoch bei Bedarf direkt aus Zoho Books löschen.
Melden Sie sich von Ihrem Zoho-Konto ab
Nachdem Sie den Code der benutzerdefinierten Funktion zu Zoho Books gepusht haben, müssen Sie sich von Ihrem Zoho-Konto abmelden. So geht’s:
- Öffnen Sie das Terminal oder die Eingabeaufforderung auf Ihrem Gerät.
- Geben Sie den Befehl ein:
npx @zohofinance/cli logout