Konfiguration

Neues Projekt erstellen

Sobald Ihr Client registriert wurde, können Sie mit der Erstellung eigener Android-Anwendungen beginnen.

Wechseln Sie über die Befehlszeile zu dem Verzeichnis, in dem Sie Ihr mobiles Projekt erstellen möchten, und führen Sie den folgenden Befehl aus.

Dies fordert Sie zur Eingabe der folgenden Benutzereingaben auf.

1. Name Ihrer mobilen App (z. B. Lead-Genehmiger)
2. Gewünschter Name des Java-Pakets Ihrer mobilen App (z. B. com.zoho.test)
3. Zoho OAuth-Client-ID (erhalten während der App-Registrierung)
4. Vertrauliche Zoho OAuth-Client-Daten (erhalten während der App-Registrierung)
5. Zoho OAuth-Weiterleitungs-URL (erhalten während der App-Registrierung)

Bei erfolgreicher Ausführung des obigen Befehls wird im gleichen Verzeichnis ein Projektordner erstellt. Der Name des Projektordners entspricht dem Namen der mobilen App.

Projekt ausführen

Das neu erstellte Projekt ist eigentlich eine Android-Demo-App, die sofort mit Android Studio ausgeführt werden kann.

1. Öffnen Sie Android Studio.
2. Klicken Sie auf Datei > Neu > Projekt importieren, wählen Sie dann den neu erstellten Projektordner, und klicken Sie auf Öffnen.
   Die neu erstellte Demo-App wird als Android-Projekt geöffnet.
3. Installieren Sie fehlende Abhängigkeiten bei Bedarf wie von Gradle empfohlen.
4. Nach erfolgreicher Gradle-Erstellung führen Sie dieses Projekt in einem Emulator aus.
   Die App wird mit einem Zoho-Anmeldebildschirm im Emulator geöffnet.
5. Melden Sie sich mit Ihren Zoho CRM-Anmeldeinformationen an, und zeigen Sie Ihre Daten mit der Demo-App an.

App erweitern

Wurde Ihr Projekt erfolgreich erstellt und ausgeführt, können Sie ganz nach Bedarf weitere Bildschirme/Funktionen gestalten und erstellen. Für die Entwicklung Ihrer App existieren keine Front-End-Einschränkungen. Stellen Sie zur Vereinfachung der Benutzerauthentifizierung jedoch sicher, dass Sie beim Gestalten Ihrer App folgende Punkte beachten.

Handhabung von An- und Abmeldung:

1. Zur korrekten Handhabung der Benutzeranmeldung wurden die Startaktivitäten bereits im SDK konfiguriert, um sicherzustellen, dass nur angemeldete Benutzer die Daten der Anwendungen sehen können.
   • Wenn Sie jedoch Ihren eigenen Anmeldebildschirm anzeigen möchten, übergeben Sie Ihr individuelles Anmeldeklassenpaket an customLoginActivityClass in app_configuration.properties. Wir starten Ihre customLoginClass als Startaktivität, sodass diese Klasse nicht separat als Starter aufgeführt werden muss. Um eine reibungslose Funktion zu gewährleisten, stellen Sie sicher, dass Sie die ZCRMLoginActivity-Absicht aus Ihrer benutzerdefinierten Startaktivität heraus starten, um das Anmeldeverfahren einzuleiten.
   • Stellen Sie beim Schreiben einer individuellen Startaktivität sicher, dass alle Aufrufe an Zoho CRM ohne Aufruf von ZCRMLoginActivity erfolgen.
2. Zur Handhabung der Benutzerabmeldung muss die Aktivität, in der Sie den Aufruf onClick Ihrer Abmeldeschaltfläche handhaben, sich auf ZCRMBaseActivity beziehen, und dessen onClick-Methode muss super.logout() aufrufen.

In der Datei app_configuration.properties:

1. mainActivityClass (erforderlich) – Erwähnen Sie Ihr Hauptklassenpaket (die Klasse, die nach der Anmeldeaktivität beginnt).
2. oauthScopes (erforderlich) – In der erstellten Eigenschaftendatei sind bereits Beispielbereiche enthalten. Diese können bei Bedarf angepasst werden.Weitere Informationen
3. accessType (optional) – Art der Umgebung in CRM
   • Produktion – Umgebung mit aktiven, zahlenden Benutzern, die auf kritische Geschäftsdaten zugreifen.
   • Entwicklung – Umgebungen, in der Sie Erweiterungen, Integrationen und Entwicklungen vornehmen können, ohne Ihre Produktionsumgebungen zu beeinflussen.
   • Sandbox – Umgebungen, die speziell zum Testen der Anwendungsfunktionalität verwendet werden, bevor die Bereitstellung in der Produktion oder die Freigabe für Kunden erfolgt.
4. minLogLevel (optional) – Erwähnen Sie hier Ihre bevorzugte Protokollstufe (ALL, FINEST, TRACE, DEBUG, CONFIG, INFO, WARNING, ERROR, OFF).
5. domainSuffix (optional) – Mehrfachunterstützung für Rechenzentren
   • us - www.zohoapis.com
   • eu - www.zohoapis.eu
   • cn - www.zohoapis.com.cn
6. PortalID (optional) – Erwähnen Sie Ihre CRM-Portal-ID (z. B. 65468393). „portalID“ muss nicht in der Eigenschaftendatei erwähnt werden, wenn nicht vorhanden.
7. showSignUp (optional) – Geben Sie den Wert als true an, wenn die App eine Anmeldemöglichkeit bietet, ansonsten lautet der Wert false.
8. customLoginActivityClass(optional) – Geben Sie hier Ihr Startaktivität-Klassenpaket an. Über diese Starterklasse können Sie Ihre Anmeldung durch Starten von ZCRMLoginActivity anpassen.

Diese Datei enthält bestimmte Konfigurationswerte, die für die Ausführung der App erforderlich sind. Ändern Sie nicht die Namen oder Werte vorhandener Eigenschaften, da diese für den reibungslosen Betrieb von SDK und App erforderlich sind.

Die Datei steht unter folgendem Pfad zur Verfügung:
project home > app > src > main > assets > app_configuration.properties.

Sie können bei Bedarf auch eigene Eigenschaften und Werte hinzufügen. Durch Aufrufen von ZCRMSDKConfigUtil.getConfigValue(propertyName); an beliebiger Stelle Ihres Java-Codes nach dem Starten der App erhalten Sie die Werte der Eigenschaften, die Sie dieser Datei hinzufügen.

Zoho CRM-API-Wrapper

Für den einfachen Datenzugriff über Zoho CRM-Rest-APIs müssen die integrierten API-SDKs für Zoho CRM verwendet werden, um über APIs auf CRM-Daten zuzugreifen. Diese Schicht kümmert sich um Ihre API-Authentifizierung (Erzeugen und Aktualisieren von OAuth-Zugriffs-Token), API-Antworten und Anforderungsstrukturen und liefert Java-Objekte, die API-Antworten enthalten.

Daher ist ein API-Aufruf dann nur noch eine Methode für die Client-App.

Wählen Sie aus der Klassenhierarchie den Abschnitt der Java-SDK-Dokumentation für Zoho CRM.

SDK-Datenzugriffs-Wrapper

Neben dem zuvor erwähnten Wrapping der Zoho CRM-APIs werden wichtige Modul-Metadaten vom SDK im lokalen Gerätespeicher gepuffert, um unnötige API-Aufrufe zu vermeiden.

Derzeit werden CRM-Daten (Datensätze) nicht gepuffert, sondern nur Metadaten von Modulen, wie Layouts, Abschnitte, Felder, individuelle Ansichten.

ZCRMCachedModule

Für ZCRMCachedModule werden einige weitere Metadaten gepuffert. Dies erweitert die Klasse ZCRMModule der Zoho CRM API-Client-Bibliothek. Diese Klasse stellt die folgenden Methoden bereit.

• GetLayouts – Gibt alle Layouts des Moduls als BulkAPIResponse zurück.
• getCustomViews – Gibt alle Moduldetails der individuellen Ansicht als BulkAPIResponse zurück.

Aktualisieren des Cache

ZCRMCachedModule speichert und verwendet die Metadaten von Modulen und Formular-Layouts, die im lokalen Speicher des Geräts zwischengespeichert sind. Das SDK aktualisiert die gespeicherten Metadaten eines Moduls alle 12 Stunden.

Wenn Sie das SDK zwingen möchten, die Cache-Funktion zu ignorieren (z. B. um mit einer Wischgeste die App zu aktualisieren) und die Metadaten über einen Zoho CRM-API-Aufruf zu aktualisieren, können Sie das Flag refreshCache setzen, dass in den überladenen Versionen der zuvor genannten Methoden enthalten ist. Ein Beispielaufruf folgt unten.