Suiteify One Start - Programmierbare Schnittstelle (API)

Dokumentationen oneSage / SData

Alles Dokumentationen zu den programmierbaren Schnittstellen oneSage / SData werden automatisch bei der Installation mitinstalliert und sind wie folgt zu finden: «C:\ProgramData\Sage\oneSage\Documentation».

Der Starter Guide ist sehr wichtig, dieser muss unbedingt gelesen werden.

Test- / Sampletools

Unter folgendem Pfad werden Beispiel-Tools installiert:

Diese können einerseits dazu genutzt werden, um zu testen, ob die Verbindung generell hergestellt werden kann. Ausserdem kann sich so ein Bild über die Funktionalität gemacht werden, da auch der komplette Sourcecode der Tools mitgeliefert werden.

OneSage / SData Troubleshooting Guide

Einleitung

Diese Anleitung wurde erstellt, damit bei Supportfällen von oneSage/SData-Zugriffen auf Infoniqa ONE Start effizienter und strukturierter vorgegangen werden kann. Die grosse Unbekannte beim Einrichten von Infoniqa ONE Start-oneSage ist die Netzwerkumgebung inklusive dessen Benutzerverwaltung. Da diese bei jedem Kunden anders ist und wir nicht genau wissen, welcher Benutzer welche Rechte hat und ob diese plötzlich vom Netzwerkadministrator geändert werden, kann es sein, dass SData plötzlich nicht mehr funktioniert. Ebenso sind Updates, Firewall oder Virenscanner eine mögliche Fehlerquelle.

Vorgehen

Vorgehen bei SData Supportfällen:

Aufzeichnen, was das System für eine Installation hat.

Handelt es sich um eine Einplatz-Version oder gibt es eine physisch getrennte Client-/Serverinstallation? Wo ist welche Infoniqa ONE Start-Version installiert.

Beispiel 1: Client-Server Installation

Beispiel 2: Einzelplatz Installation

 

Den Kunden fragen, was er genau machen will? Von wo will er mit was auf welches Dossier zugreifen?

• Den Kunden fragen, ob kürzlich etwas von den folgenden Änderungen gemacht wurden:

• Neuinstallation oder Autoupdate von Infoniqa ONE Start durchgeführt?

• Änderungen an Hardware durchgeführt?

• Änderungen an Firewall durchgeführt?

• Änderungen an Virenscanner durchgeführt?

Problemanalyse

Ist die Ausgangslage klar definiert, kann man sich von innen nach aussen durcharbeiten:

• Auf dem Server, auf welchem das Dossier physisch liegt, den Infoniqa ONE Start-Client starten und kontrollieren ob damit auf das Dossier zugegriffen werden kann. Falls OK, Client wieder schliessen und weiter mit nächstem Schritt.

• ConnectorTestRD.exe: Dieses Programm kann verwendet werden, um oneSage zu testen und eine allfällige Lösung eines Schnittstellenpartners zu simulieren.

• Auf dem Server das ConnectorTestRD.exe starten (C:\ProgramData\Sage\oneSage\Sample\ConnectorTestRD\ConnectorTestRD.exe). Als erstes zweimal „Infoniqa ONE Start" auswählen und anschliessend das zu testende Dossier über „Server" auswählen. Wird nun ein „Select" auf die Ressource „Account" ausgeführt, müssen in der Tabelle auf der rechten Seite die Konten sichtbar sein:
  
  Funktioniert dies, ist oneSage auf dem Server funktionsfähig. ConnectorTestRD.exe schliessen und weiter mit dem nächsten Schritt.
  SData: Der SData-Service muss immer auf dem PC-laufen, auf welchem der SageServer läuft.

• Auf dem Server unter Start (Windows) à Sage à oneSage à „SData Konfiguration" starten. Unter „Advanced" kontrollieren, ob der SData-Dienst gestartet ist.Der SData-Dienst ist standardmässig aus Sicherheitsgründen immer ausgeschaltet. ACHTUNG: Es kann sein, dass nach der Installation eines Autoupdates (bei Infoniqa ONE Start immer eine Vollinstallation) der SData-Dienst wieder eingeschaltet werden muss.

• In der SData-Konfiguration den SData-Dienst restarten. Über die Windows-Dienste kontrollieren, ob der Dienst auch wirklich läuft:
  
  In der SData-Konfiguration kann falls nötig über den Knopf „Windows Firewall" die Firewall konfiguriert werden. Ist der Knopf nicht sichtbar, ist dies bereits geschehen. Siehe auch „Still having problems?"
  
  Jetzt muss der Zugang über den SData-Service von überall her gewährleistet sein. Je nach Installation, jetzt auf den Client wechseln, von welchem aus über SData auf den Server zugegriffen werden möchte. Als erstes vom Client prüfen, ob der Server über das Netzwerk erreichbar ist: Ping an den Server senden. Einmal mit IP und evtl. einmal mit Hostnamen, damit sicher ist, dass dieser aufgelöst werden kann.

• SData-Browser: Dieses Programm kann verwendet werden, um SData zu testen und eine allfällige Lösung eines Schnittstellenpartners zu simulieren.

• Auf dem Client den SData-Browser starten (falls Infoniqa ONE Start installiert wurde, kann der SData-Browser hier gefunden werden: C:\ProgramData\Sage\oneSage\SData\Tools\SDataBrowser.msi à Installieren und über Windwos-Start öffnen)

• Im SData-Browser eine neue Verbindung hinzufügen und die IP des Servers eingeben(bei Einzelplatz à „localhost"):
  

• Über die Baumstruktur bis zum Gewünschten Dossier gehen, die Ressource „Account" markieren (hat immer Daten) und über den Knopf „GET feed" Daten anfordern.
  
  Damit wäre auch der Zugriff wie SData erfolgreich. Da SData eine Webschnittstelle ist, kann diese von überall her angesprochen werden.

Lokal/Netzwerk

Im Infoniqa ONE Start kann bei einer Einzelplatz-Installation ein Dossier „lokal" oder über das „Netzwerk" geöffnet werden. Sobald die Schnittstelle verwendet wird, muss dieses immer über das Netzwerk geöffnet werden. Lokal werden Dossiers nur bei Einzelplatz-Installationen ohne Schnittstellen-Zugriff verwendet.

Benutzer

Standardmässig sollte SData ohne zusätzlichen Benutzer eingerichtet werden. Es kann jedoch vorkommen, dass bei einer Server-Installation immer ein Benutzer angemeldet sein muss, damit SData funktioniert. In diesem Fall muss auf dem Server ein zusätzlicher Benutzer eingerichtet werden:

Ohne zusätzliche Benutzer

• Infoniqa ONE Start inkl. oneSage wird ganz normal auf dem Server installiert.

• Der SData-Dienst auf dem Server muss gestartet werden.

• Die Firewall Einstellungen müssen gemacht werden.

Mit zusätzlichen Benutze

• Infoniqa ONE Start inkl. oneSage wird ganz normal auf dem Server installiert.

• Der SData-Dienst auf dem Server muss gestartet werden

• Firewall Einstellungen müssen gemacht werden

• Es muss ein neuer User(mit Admin-Berechtigung) erstellt werden, welcher dem SData-Dients und dem DCOM-Dienst „Sage.Application" hinterlegt werden muss(siehe detailliertere Anleitung unten)

• Es muss sichergestellt werden, dass nach jedem Autoupdate diese Konfiguration wieder hergestellt wird.

Anleitung zum Einrichten eines zusätzlichen SData-Benutzers

Betreffend dem Problem, dass auf dem SData-Server immer ein Benutzer angemeldet sein muss, gibt es folgende Lösung:

• Einen neuen Benutzer mit Administratoren Rechten anlegen(z.B. SDataUser)

• In der DCOM-Konfiguration muss dieser Benutzer zugewiesen werden:
  SystemsteuerungàVerwaltungàKomponentendiensteàComputeràArbeitsplatzàDCOM-KonfigurationàSage.Application Eigenschaften(rechtsklick) (Control panelàAdministative ToolsàComponent ServicesàComputersàMy ComputeràDCOM-ConfigàSage.Application Properties(rechtsklick))
  

• Auf dem SData Service muss derselbe Benutzer ebenfalls hinterlegt werden:
  Systemsteuerung – Verwaltung – Dienste (Control Panel - Administative Tool Services)
  

• Alles neu starten. Evtl. sich einmal mit dem neu erstellten Benutzer manuell anmelden, damit dieser eingerichtet wird. Anschliessend sollte der SData-Server auch ohne angemeldeten Benutzer zugänglich sein.

Diverses

Lizenzen

Sind genug Lizenzen vorhanden? Es gilt zu beachten, dass der Schnittstellen-Zugriff über COM den Infoniqa ONE Start Client startet. In diesem Moment wird die Lizenz auf dem Lizenzserver abgefragt. Evtl. kann dies auch zu Problemen führen, falls bereits alle Lizenzen in Gebrauch sind.

Bekannte Probleme / FAQ

SData request to Infoniqa ONE Start results in error Error 8000401a

An SData request reports the following error message: „COMExcpetion: Die COM-Klassenfactory für die Komponente mit CLSID {1001B580-4000-0003-AEB4-0000E80C11B9} konnte aufgrund des folgenden Fehlers nicht abgerufen werden: 8000401a."

Solution: In order that Infoniqa ONE Start application and SData can run simultaneously, SData for Infoniqa ONE Start is configured to use the "Interactive User" and thus needs a logged-in windows user. Please ensure that there is a logged-in windows user where Infoniqa ONE Start is running.

Problem Dezimal-Trennzeichen Windows 8.1

Fix von Microsoft für das Problem mit der Lokalisierung:

https://support.microsoft.com/kb/3060383

https://support.microsoft.com/de-ch/kb/2979059

Es muss sichergestellt werden dass alle Benutzer die korrekten Regionseinstellungen verwenden:

• Registry öffnen und nach „sDecimal" suchen

• Falls die Regionseinstellung auf „de-CH" gesetzt ist, das Dezimaltrennzeichen(sDecimal) auf den Wert auf „Punkt" setzen:
  

• Dies muss für alle vorhandenen Benutzer gemacht werden(Suche mit „F3" fortsetzen):
   

Infos und weitere Links finden Sie z.B. hier: https://social.technet.microsoft.com/Forums/de-DE/c1ca1764-fe6a-49bc-9efc-8ccc3ea6609c/since-windows-81-the-input-locale-for-swissgerman-has-a-wrong-decimal-separator?forum=w8itprogeneral 

Zugriff auf Dossier nicht möglich

Es konnte nicht auf ein auf dem Server liegendes Dossier zugegriffen werden.

Lösung:

Dossiers auf dem Server müssen immer unter dem Standardverzeichnis von Infoniqa ONE Start liegen(C:\SageData\Folders\<Kunde>\Infoniqa ONE Start\<Dossier>\ ) ansonsten können diese nicht gefunden werden. Liegt das Dossier jedoch nicht da, kann es über die Config-Datei im oneSage definiert werden. à Siehe Doku im oneSage

Fehler beim Setzen von Variablen Lohndaten

Es gab einen Fehler beim Setzen der Variablen Lohndaten. Es wurden die Lohnarten 550(Wert auf 8.3) und 551(Wert auf 10) gesetzt. Beim Lohnart 550 gab es einen Fehler und 551 wurde korrekt gesetzt.

Lösung:

Microsoft Patch für Lokalisierungsproblem bei Windows 8.1 installieren, da 8.3 auf 8,3 geändert wurde

Fix von Microsoft für das Problem mit der Lokalisierung:

https://support.microsoft.com/kb/3060383

https://support.microsoft.com/de-ch/kb/2979059

Beim Setzen der Variablen Lohndaten muss mehrfach das Passwort eingegeben werden

Das Infoniqa ONE Start Dossier ist Passwort geschützt. In diesem Fall muss logischerweise bei jedem Zugriff, auch über die Schnittstelle, Benutzername und Passwort mitgegeben werden

Lösung:

Der Drittanbieter muss das Passwort in Ihrer Applikation zwischenspeichern.

Is there a specific approach to have better logs from oneSage SDK?

Currently there are no other approach.

Do you have some recommendation about sending large data through SData ? (the process is long, about 1 second by customer for example…)

A recommendation is to send all the Data in one Request. This because otherwise you have the HTTP Overhead in every single request and this can have a duration around 1 second per call.

Do you recommend to close Infoniqa One Start before using SData synchronization ?

An open Infoniqa ONE Start during writing can have a time impact and it could be also that a write process is blocked or slower.

Es können mit ConnectorTestRD.exe keine Daten abgerufen werden

Falls es nicht möglich ist mit dem ConnectorTestRD.exe Daten vom Dossier abzurufen resp. der ConnectorTestRD einfriert, kann es sein, dass Infoniqa ONE Start in der COM-Schnittstelle nicht mehr richtig registriert ist. 

Um die COM-Schnittstelle von Infoniqa ONE Start neu zu registrieren musst du folgende Schritte ausführen:

• Eingabeaufforderung als Administrator starten

• Zu Pfad ..\Program Files (x86)\Sage\Infoniqa ONE Start wechseln

• COM-Registrierung löschen -> SageStart.exe /unregserver

• COM neu registieren -> SageStart.exe /regserver

• COM-Guid registrieren -> SageStart.exe /regserver /ComGUID={1001B580-4000-0003-AEB4-0000E80C11B9}