Neue Instanz

<< Klicken Sie hier, um das Inhaltsverzeichnis anzuzeigen >>

Navigation:  »Keine Themen oberhalb dieser Stufe«

Neue Instanz

Neue Instanz

Damit die Daten zwischen einem Programm und der Proffix Px5 Installation über das Internet ausgetauscht werden können, muss ein Webservice konfiguriert werden.

Erstellen Sie eine neue Instanz mit Klick auf Start > Neu REST API neu_16x16 und wählen Sie den gewünschten Typ:

▪REST API Instanz

▪Aufgaben Instanz (für Aufgabenverwaltung Proffix_Aufgabenverwaltung_16x16)

▪Exchange Sync Instanz (für Outlook Web Add-In)

Hinweis:

▪Der Instanzname darf weder ein Sonder- noch ein Leerzeichen beinhalten.

Tipp:

▪Wenn Sie mehrere Webservices für verschiedene Kunden verwenden, geben Sie am besten den Kundennamen ein.

Was möchten Sie tun?

Toggle-auf_16x16_blackNeue REST API Instanz erstellen

Um eine neue REST API Instanz zu erstellen, gehen Sie wie folgt vor:

1.Proffix Server-Manager starten.

2.Wählen Sie Start > Instanz > Neu > REST API Instanz.

SrvMan_RestApiInstanz

3.Definieren Sie einen Instanznamen, zwingend ohne Sonder- und Leerzeichen.

4.Geben Sie, falls gewünscht, einen Dienstbenutzer und das Passwort ein.

5.Wählen Sie die gewünschte Version.

6.Aktivieren Sie die Option QR Code Instanz, falls Sie QR Code Zugang für mobile Apps verwenden wollen.

7.Geben Sie die öffentliche URL und ein Passwort ein.

8.Klicken Sie auf Symbol Ordner suchen Ordner geöffnet_16x16, rechts neben dem Feld Verzeichnis, um ein Verzeichnis auszuwählen.

9.Die Konfigurationsdatei und das Daten-Verzeichnis werden automatisch vorgeschlagen. Kontrollieren Sie die Angaben.

10.Geben Sie allfällige weitere Angaben ein.

11.Speichern Sie mit Klick auf Ok Bestätigen_16x16.

12.Nun wird der Webservice eingerichtet und konfiguriert. Zusätzlich wird eine Windows Firewall-Regel hinzugefügt.

Instanzname

Geben Sie hier die Bezeichnung der Instanz an.

Dienstbenuzter

Geben Sie hier falls gewünscht den Dienstbenutzer ein.

Passwort

Geben Sie hier falls gewünscht das Passwort des Dienstbenuzters ein.

Version

Hier sehen Sie die gewählte Version der REST API Instanz. Wählen Sie wenn immer möglich die neueste Version aus. Beachten Sie, dass diese kompatibel mit den Programmen sein muss, die auf die Proffix REST API zugreifen.

QR Code Instanz

Wählen Sie diese Option aus, wenn diese Instanz für den Zugriff durch mobile Apps verwendet wird. Ensprechend wird der QR-Code in Proffix Px5 konfiguriert.

Öffentliche URL

In diesem Feld müssen Sie die URL hinterlegen beginnend mit https:// (nicht empfohlen wird http://). Über diese URL wird die REST API in Applikationen aufgerufen. Diese Einstellung dient dazu, in Proffix Px5 den QR Code für die Konfiguration der mobilen Apps generieren zu können.

Hinweise:

▪Die öffentliche URL muss eine Portangabe beinhalten, sobald der verwendete Port nicht dem Standard-Port 443 für HTTPS entspricht.

▪Die öffentliche URL gilt nicht für die Zeiterfassungsterminals.

Passwort

Definieren Sie hier ein beliebiges Passwort. Dieses muss auf dem Client-Programm ebenfalls in der Konfiguration eingegeben werden. Mit diesem Passwort wird sichergestellt, dass kein unbefugter Zugriff auf die Liste der Datenbanken erfolgen kann.
Dieses Passwort wird in Proffix Px5 standardmässig im QR Code hinterlegt, welcher wiederum für das Login der mobilen Apps verwendet werden kann.

REST API Doku deaktivieren

Wählen Sie diese Option aus, wenn Sie für diese Instanz die REST API Doku deaktivieren wollen. Die Schaltfläche Dokumentation Entwicklerhandbuch_16x16 im Startregister wird deaktiviert, falls diese Option aktiviert ist.
Falls die lokale Proffix REST API Dokumentation aktiviert ist, ist sie unter der öffentlichen URL mit dem zusätzlichen Pfad /api-docs/ erreichbar, z.B. https://localhost:5002/api-docs/.

Debugger deaktivieren

Wählen Sie diese Option aus, wenn diese Instanz für den Zugriff mit dem Debugger nicht verfügbar sein soll. Die Schaltfläche Debugger REST API Debugger_16x16 im Startregister wird deaktiviert, falls diese Option aktiviert ist.

Bindungen

Hier können Sie Bindungen erstellen, kopieren, ändern oder löschen. Damit mit der REST API kommuniziert werden kann, muss mindestens eine Bindung definiert werden. Eine Bindung legt fest, welche Verbindungen akzeptiert werden.

Proffix

Verzeichnis

In diesem Feld geben Sie das Verzeichnis der dazugehörigen Proffix Px5 Installation an.

Konfigurationsdatei

Wenn Sie ein Verzeichnis auswählen, wird die Konfigurationdatei automatisch abgefüllt.

Daten-Verzeichnis

Wenn Sie ein Verzeichnis auswählen, wird das Daten-Verzeichnis automatisch abgefüllt.

Erweiterte Einstellungen

Format

Das Format gibt an, welche Datums- bzw. Sprach-Einstellungen für die Proffix REST API unabhängig von den Windows-Einstellungen gesetzt werden sollen. Im Feld Format werden beim Anlegen einer neuen Instanz automatisch die Sprach-Einstellungen des aktuellen Windows-Benutzers geladen. «Standard» bedeutet, dass die Sprach-Einstellungen des REST API Dienstbenuzters wirksam sind.

Eine spezielle Auswahl dieses Felds ist erforderlich, falls die Windows Sprach-Einstellungen von den erwünschten Zahlenformats-Einstellungen (Tausender- & Dezimaltrennzeichen) beim Ausdruck von Proffix Listen abweichen.
Beispiel: Windows Server Sprache ist «Englisch (USA)». Die REST API soll aber Listen mit Schweizer Zahlenformat (Tausender- & Dezimaltrennzeichen) ausgeben. Dann muss das Feld Format auf «Deutsch (Schweiz)» gesetzt werden.

Log-Level

Das Log-Level gibt an, was in der Proffix REST API alles protokolliert wird. Je tiefer das Level, desto mehr wird protokolliert. Sie können zwischen drei Levels wählen:

▪Trace: Alles wird protokolliert, sogar sensitive Daten wie Passwörter usw. Sollte ausschliesslich zur Fehleranalyse verwendet werden.

▪Information: Informationen zum Betrieb und alltägliche Fehler, wie z.B. falscher Benutzername oder falsches Passwort, werden protokolliert.

▪Warning: Erwartete, nicht alltägliche Fehler, wie z.B. wenn die Badge-ID nicht gefunden werden konnte, weil sie nicht in Proffix Px5 eingetragen wurde, werden protokolliert.

Sichtbarkeit der Datenbanken definieren

Aktivieren Sie diese Option, wenn Sie definieren wollen, welche Datenbanken in der Liste der Datenbanken zurückgeliefert werden sollen. Der Zugriff auf die Datenbanken ist trotzdem möglich, wenn ein Benutzer die entsprechenden Rechte besitzt und den Namen der Datenbank kennt. Diese Funktion schränkt nur die Sichtbarkeit von aussen ein.
Ist die Option nicht aktiviert, werden automatisch alle Datenbanken zurückgeliefert.

Verzeichniszuordnungen

Hier können Sie die Verzeichniszuordnungen erstellen Tabelle neu_16x16, kopieren Tabelle kopieren Zeile ausgewählt_16x16, ändern Tabelle ändern Zeile ausgewählt_16x16 oder löschen Tabelle löschen Zeile ausgewählt_16x16.

Lizenzen

Wählen Sie in der Liste der Module jedes REST API Modul per Doppelklick an, welches Sie verwenden wollen und geben Sie die Anzahl der Geräte/Benutzer ein, welche gleichzeitig Zugang zu diesem Modul der REST API haben können.

Erweiterungen

Hier können Sie die Erweiterungen erstellen Tabelle neu_16x16, kopieren Tabelle kopieren Zeile ausgewählt_16x16, ändern Tabelle ändern Zeile ausgewählt_16x16 oder löschen Tabelle löschen Zeile ausgewählt_16x16.

Was möchten Sie tun?

Damit mit der REST API kommuniziert werden kann, muss mindestens eine Bindung definiert werden. Eine Bindung legt fest, welche Verbindungen akzeptiert werden. Wenn Sie eine neue Bindung erstellen möchten, gehen Sie wie folgt vor:

1.Klicken Sie auf die Schaltfläche Neue Bindung Tabelle neu_16x16 rechts neben der Tabelle Bindungen.

SrvMan_RestApiInstanz_Bindung

2.Geben Sie die nötigen Angaben ein.

3.Speichern Sie mit Klick auf Ok Bestätigen_16x16.

Tipp:

▪Bereits erstellte Bindungen können Sie kopieren Tabelle kopieren Zeile ausgewählt_16x16, ändern Tabelle ändern Zeile ausgewählt_16x16 oder löschen Tabelle löschen Zeile ausgewählt_16x16.

IP-Adresse

Mit der Eingabe einer IP-Adresse schränken Sie die Verbindungsmöglichkeiten auf die angegebene IP ein.

Wenn Sie dieses Feld leer lassen, sind Verbindungen uneingeschränkt möglich. Bspw. werden Anfragen von «beispiel.proffix.ch» und «localhost» entgegengenommen.

Port

Wählen Sie einen freien Port. Der ausgewählte Port wird automatisch in der Windows Firewall geöffnet.

SSL

Verwenden Sie die Option SSL, um über einen gesicherten (verschlüsselten) Kanal zu kommunizieren. Ausser für die Zeiterfassungsterminals empfehlen wir diese Option dringend.

Zertifikat

Wenn Sie die Option SSL aktiviert haben, benötigen Sie ein Zertifikat. Das Zertifikat im .pfx-Format kann über die Schaltfläche Zertifikat_16x16 auf der rechten Seite importiert werden. Falls Sie kein Zertifikat besitzen, können Sie bei einer gängigen Zertifizierungsstelle eines erwerben (z.B. https://godaddy.com/web-security/ssl-certificate oder https://ssl.comodo.com/comodo-ssl-certificate.php).

Hinweis:

▪Verwenden Sie wenn möglich keine Self-Signed Zertifikate, da diese in der Vergangenheit zu Problemen geführt haben.

Tipp:

▪Mit F4 oder Klick auf Suchfenster öffnen Tabelle_16x16 gelangen Sie jeweils in die Hilfstabellen oder in das jeweilige Modul.

Die Verzeichniszuordnung muss verwendet werden, wenn die REST API nicht direkt auf die Proffix Px5 Dateien zugreifen kann. Dies ist meist der Fall, wenn sich die REST API in der DMZ (Demilitarisierte Zone) befindet und Proffix Px5 im internen Netz. Die Dateien werden in diesem Fall z.B. mittels Jobs synchronisiert. Die Verzeichniszuordnung passt in diesem Fall den Dateinamen so an, dass Proffix Px5 darauf zugreifen kann.

1.Klicken Sie auf die Schaltfläche Neue Verzeichniszuordnung Tabelle neu_16x16 rechts neben der Tabelle Verzeichniszuordnungen.

SrvMan_RestApiInstanz_Verzeichniszuordnung

2.Geben Sie die nötigen Angaben ein.

3.Speichern Sie mit Klick auf Ok Bestätigen_16x16.

Tipp:

▪Bereits erstellte Verzeichniszuordnungen können Sie kopieren Tabelle kopieren Zeile ausgewählt_16x16, ändern Tabelle ändern Zeile ausgewählt_16x16 oder löschen Tabelle löschen Zeile ausgewählt_16x16.

Quellverzeichnis

Definieren Sie hier das Verzeichnis aus Sicht von Proffix Px5.

Zielverzeichnis

Geben Sie hier das Verzeichnis aus Sicht der REST API ein.

Uploadziel

Wenn Sie upgeloadete Dateien in verschiedenen Verzeichnissen ablegen möchten, wählen Sie hier ein Uploadziel aus.

Wählen Sie «Nicht verwenden», falls der Pfad aus Proffix Px5 aus Sicht der Proffix REST API angelegt, aber nicht für den Upload verwendet werden soll. Nur für den Download.
Wählen Sie «Allgemein», wenn die Dateien direkt im angegebenen Verzeichnis gespeichert werden sollen.

Verzeichniserweiterung

Mit der Verzeichniserweiterung werden auf Wunsch zusätzlich Unterverzeichnisse mit dem Jahr und dem Monat erstellt.

Beispiel:
Quelle: C:\bilder\bild.png (aus Sicht von Proffix Px5)
Ziel:      \\netzlaufwerk\bilder\bild.jpg (aus Sicht der Proffix REST API)
In diesem Fall ist eine Zuordnung von «C:\bilder» nach «\\netzlaufwerk\bilder» anzulegen.

Zu beachten ist, dass man von zwei Konstellationen ausgehen kann:

1.Das Quellverzeichnis entspricht dem Zielverzeichnis. Jedoch wird auf ein Verzeichnis aus dem Netz zugegriffen, also per Netzlaufwerk.
Hierzu wird im Gegensatz zu Punkt 2 keine Synchronisation gebraucht, da der Inhalt der Verzeichnisse identisch ist.

2.Das Quellverzeichnis entspricht NICHT dem Zielverzeichnis. Diese Konstellation kann auftreten, falls man eine Proffix REST API komplett von Proffix Px5 trennt. Die Quelle wird für den Datenbankeintrag in Px5 verwendet. Das Ziel für die Ablage auf dem Server mit der Proffix REST API. 
In diesem Fall muss vom Betreiber der Proffix REST API sichergestellt werden, dass die Dateien dieser beiden Verzeichnisse in beide Richtungen synchronisiert werden.

Für jede REST API Modul Lizenz müssen Sie die Anzahl Geräte definieren.

1.Wählen Sie ein REST API Modul in der Tabelle Lizenzen aus.

2.Klicken Sie auf die Schaltfläche Anzahl Geräte definieren Tabelle ändern Zeile ausgewählt_16x16 rechts neben der Tabelle Lizenzen.

SrvMan_RestApiInstanz_Geräte

3.Geben Sie die Anzahl der Benutzer, welche gleichzeitig Zugang zu diesem REST API Modul haben, im Feld Geräte ein.

4.Falls Sie die Option Demo aktivieren, wird automatisch eine 30-tägige Demoversion gelöst und das entsprechende Modul aktiviert.

5.Speichern Sie mit Klick auf Ok Bestätigen_16x16.

Hinweis:

▪Das Ablaufdatum der Demolizenz ist in der Übersicht der Lizenzen ersichtlich, sobald die REST API Instanz erneut bearbeitet wird.

Tipp:

▪Beispiel für die Definition der Anzahl: Beim Einsatz des Zeiterfassungsterminals für 8 Mitarbeitende, wenn zusätzlich 2 dieser Mitarbeitenden noch die Proffix Px5 Time App verwenden, geben Sie bei der Lizenz für das Modul Zeitverwaltung im Feld Geräte «10» ein.

Toggle-auf_16x16_blackNeue Aufgaben Instanz erstellen

Damit Sie die Aufgabenverwaltung Proffix_Aufgabenverwaltung_16x16 in Px5 verwenden können, benötigen Sie eine Instanz des Typ Aufgaben Instanz.

1.Proffix Server-Manager starten.

2.Wählen Sie Start > Instanz > Neu > Aufgaben Instanz.

SrvMan_Aufgabeninstanz

3.Definieren Sie einen Instanznamen, zwingend ohne Sonder- und Leerzeichen.

4.«Version 1.3.1 kompatibel zu 5.0.1008» wird automatisch vorgeschlagen.

5.Geben Sie, falls gewünscht, einen Kontonamen und das Passwort des System-Administrators ein.

6.Klicken Sie auf das Symbol Ordner suchen Ordner geöffnet_16x16 rechts neben dem Feld Verzeichnis, um ein Verzeichnis auszuwählen.

7.Die Konfigurationsdatei und das Daten-Verzeichnis werden automatisch vorgeschlagen. Kontrollieren Sie die Angaben.

8.Klicken Sie auf das Symbol Neues Export-Verzeichnis Tabelle neu_16x16, um den Speicherort für den Listen-Export zu definieren.

9.Geben Sie eine Bezeichnung für das Export-Verzeichnis ein.

10.Mit Klick auf Ordner suchen Ordner geöffnet_16x16 wählen Sie den Ordner aus, in welchem die exportierten Listen gespeichert werden sollen.

11.Klicken Sie zweimal auf Ok Bestätigen_16x16, um die Konfigurationen zu speichern.

Hinweis:

▪Damit das Drucken möglich ist, ist es empfehlenswert, den Dienst mit einem Administrator-Benutzer zu erstellen.

▪Werden Dezimaltrennzeichen, Datumsformate etc. anders dargestellt, als wenn Sie eine Liste direkt aufbereiten, dann geben Sie in der Aufgaben Instanz Kontonamen und Passwort des Benutzers an, welche die gewünschten Regionseinstellungen definiert hat. Als Alternative definieren Sie in den Systemeinstellungen > Regionen > Verwaltung > Einstellungen kopieren die gewünschten Spracheinstellungen für neue Benutzer und löschen anschliessend zuerst im Proffix Server-Manager die Aufgaben Instanz und erstellen diese nochmals neu. Somit wird der Dienst mit den neuen Einstellungen erstellt.

Instanzname

Geben Sie hier die Bezeichnung der Instanz an.

Version

Hier sehen Sie die gewählte Version der Aufgaben Instanz. Wählen Sie wenn immer möglich die neueste Version aus.

Kontoname

Geben Sie hier falls gewünscht den Kontonamen des System-Administrators ein.

Passwort

Geben Sie hier falls gewünscht das Passwort des System-Administrators ein.

Proffix

Verzeichnis

In diesem Feld geben Sie das Verzeichnis der dazugehörigen Proffix Px5 Installation an.

Konfigurationsdatei

Wenn Sie ein Verzeichnis auswählen, wird die Konfigurationdatei automatisch abgefüllt.

Daten-Verzeichnis

Wenn Sie ein Verzeichnis auswählen, wird das Daten-Verzeichnis automatisch abgefüllt.

Export-Verzeichnisse

Klicken Sie auf das Symbol Neues Export-Verzeichnis Tabelle neu_16x16, um den Speicherort für den Listen-Export zu definieren.

Bestehende Export-Verzeichnisse können Sie kopieren Tabelle kopieren Zeile ausgewählt_16x16, ändern Tabelle ändern Zeile ausgewählt_16x16 oder löschen Tabelle löschen Zeile ausgewählt_16x16.

Drucker

Wählen Sie die Drucker aus, die Sie in der Aufgabenverwaltung Proffix_Aufgabenverwaltung_16x16 verwenden möchten.
Toggle-auf_16x16_blackNeue Exchange Sync Instanz erstellen

Damit die zwischengespeicherten Outlook E-Mails vom Exchange Server ins Px5 übermittelt werden können, benötigt es eine ExchangeSync Instanz im Proffix Server-Manager.

1.Proffix Server-Manager starten.

2.Wählen Sie Start > Instanz > Neu > ExchangeSync Instanz.

Out_Web_ExchangeSyncInstanz

3.Definieren Sie einen Instanznamen, zwingend ohne Sonder- und Leerzeichen.

4.Wählen Sie die gewünschte Version.

5.Geben Sie, falls gewünscht, einen Kontonamen und das Passwort des System-Administrators ein.

6.Klicken Sie auf Symbol Ordner suchen Ordner geöffnet_16x16 rechts neben dem Feld Verzeichnis, um ein Verzeichnis auszuwählen.

7.Die Konfigurationsdatei und das Daten-Verzeichnis werden automatisch vorgeschlagen. Kontrollieren Sie die Angaben.

8.Speichern Sie mit Klick auf Ok Bestätigen_16x16.

Instanzname

Geben Sie hier die Bezeichnung der Instanz an.

Version

Hier sehen Sie die gewählte Version der Exchange Sync Instanz. Wählen Sie wenn immer möglich die neueste Version aus.

Kontoname

Geben Sie hier falls gewünscht den Kontonamen des System-Administrators ein.

Passwort

Geben Sie hier falls gewünscht das Passwort des System-Administrators ein.

Proffix

Verzeichnis

In diesem Feld geben Sie das Verzeichnis der dazugehörigen Proffix Px5 Installation an.

Konfigurationsdatei

Wenn Sie ein Verzeichnis auswählen, wird die Konfigurationdatei automatisch abgefüllt.

Daten-Verzeichnis

Wenn Sie ein Verzeichnis auswählen, wird das Daten-Verzeichnis automatisch abgefüllt.