Verwendung

Die ENTERPRISE Daemon API (EDA) ist die Web-Service-Schnittstelle des CLARC ENTEPRRISE Services (ccenterprisesrv.exe).

Über die Schnittstelle können u.a. Informationen zu Diensten und dem Systemstatus abgefragt werden. Darüber hinaus können beispielsweise einzelne Dienste gestartet oder beendet werden.

Minimale Server-Version

Die minimale Version ist die 5.0.2.x.

Url Parameter

Jeder Aufruf benötigt folgenden Parameter:

authcode=<InstanceToken des enterprise daemons>

Der Wert kann aus C4 ermittelt werden:

/clarc/Software/clarc enterprise daemon/Cluster/Node 0

Fester AuthCode für den ENTERPRISE Daemon

Der AuthCode/InstanceToken wird einmalig beim Start des Dienstes festgelegt. Dieser kann vor dem Start des Dienstes neu generiert werden, indem der InstanceToken geleert wird. Ansonsten wird der generierte Code weiterhin verwendet.

Die Rückgabe ist immer ein XML im CLARC Fast XML Format bei HTTP 200 OK.

Aufbau einer Url mit Beispiel:

http(s)://<server>:<port>/ccedapi_getsystemstate&authcode=<InstanceToken>

CCEDAPI_GETSYSTEMSTATE

Abruf des allgemeinen Systemstatus.

Parameter	Hinweis
Version	Installierte Produktversion
Licensee	Lizenznehmer
Proxy	Ja/Nein
ProxyInstance	Ja/Nein
ClusterNode	Nur bei Proxy = false
StartTime	Startzeit des Enterprise daemons (yyyy-mm-dd hh:nn:ss)
ServerTime	Datum Uhrzeit vom Server (yyyy-mm-dd hh:nn:ss)
Uptime	In Sekunden
Services	Anzahl
CloudServicesAvailable	true/false
Warnings	Anzahl der Warnungen (insgesamt)
Errors	...
Criticals	...

CCEDAPI_GETRELEASEINFO

Informationen zum installierten Release (Cloud Services müssen verfügbar sein - also Internetverbindung).

Parameter	Hinweis
Version	z.B. 5.0.0.705
Date	Releasedatum (z.B. 01.01.2015)
Supported	Supportete Version?
Productive	Produktive Version oder Test?
About	Hinweise zum Release
Alerts	Warnungen zum Release
LatestRelease	Aktuell verfügbarste Version

CCEDAPI_GETSERVICES

Übersicht aller registrierten Services im enterprise daemon.

Parameter	Attribut	Hinweis
<ServiceName>		Inhalt ist der Infotext zum Service
	Id	InstanceId (0,1,...)
	Token	InstanceToken - wird für weitere Methoden benötigt
	Status	SVC_Stop_Pending,SVC_Start_Pending,SVC_Stopped,SVC_Running
	ProcessState	Windows Prozess aktiv (BOOL)
	InterfaceState	Web-Interface verfügbar (BOOL)
	DisplayName	Anzeigename für den Service
	Criticals	Anzahl der kritischen Fehler (z.B. Zugriffsverletzungen)
	Errors	Anzahl
	Warnings	Anzahl
	Restarts	Anzahl
...

CCEDAPI_GETSERVICEDETAILS

Details zu einem spezifischen Service.

Benötigt als Url Parameter token=<InstanceToken>.

Parameter	Hinweis
Name	Technischer Name
Info	Beschreibungstext
c4Node	Knoten im c4
Disabled	Service wurde deaktiviert (z.B. wegen zu vieler Restarts)
StoppedByUser	Service von einem Benutzer beendet?
Status	SVC_Running, SVC_Start_Pending, SVC_Stop_Pending, SVC_Stopped (0,1,2,...)
Uptime	Uptime in Sekunden
CreationDate	Angelegt am (DateTime Wert) (besser yyyy-mm-dd hh:nn:ss ???)
ChangeDate	Geändert am (DateTime Wert)
StartDate	Startdatum (DateTime Wert)
Restarts	Anzahl der Neustarts
Port	TCP Port
PrimaryPort	Primärport (bei Instanz > 0 abweichend)
Url	Basis-Url des Services
InstanceId	0,1,2,... (0 ~ Primärinstanz)
InstanceToken	U.a. für Zugriff (authcode)
MasterInstance	InstanceId = 0 (true/false)
MutexName	intern
DisplayName	Anzeigename des Services
ProcessState	true/false (false ~ inaktiv)
InterfaceState	true/false (false ~ nicht verfügbar oder noch nicht bekannt)
CPUPlatform	32 oder 64 bit (String)
MemoryUsage	Speichernutzung in Byte
CurrentErrors	Anzahl der Fehler heute
CurrentWarnings	...
CurrentCriticals	...
CurrentDocuments	...
OverallErrors	Gesamtanzahl der Fehler über die Laufzeit des Enterprise daemons
OverallWarnings	...
OverallCriticals	...
OverallDocuments	...
ServicePath	Pfad zur Service .exe (z.B. c:\clarc\sys\)
ServiceFileName	Dateiname des Services (z.B. ccasesrv.exe)
ServiceStartParams	Optionale Startparameter
ServiceFileCompanyName	Detailinformationen aus den Dateieigenschaften
ServiceFileDescription	...
ServiceFileVersion	...
ServiceFileInternalName	...
ServiceFileLegalCopyright	...
ServiceFileLegalTrademarks	...
ServiceFileOriginalName	...
ServiceFileProductName	...
ServiceFileProductVersion	...
ServiceFileComment	...
Raw_...	Ungefilterte Statusinformationen vom jeweiligen Dienst (nach Raw_ kommt der eigentliche Name der Property)
Raw_...	...
usw.

CCEDAPI_GETSERVICELOG

Live-Log (die letzten n Einträge) zu einem spezifischen Service.

Benötigt als Url Parameter token=<InstanceToken>.

Parameter	Hinweis
Log	Raw Logtext einer Zeile (analog zum Aufbau im Logfile)
...

CCEDAPI_GETLICENSELOG

Live-Log (die letzten n Einträge) des License-Daemons.

Parameter	Hinweis
Log	Raw Logtext einer Zeile (analog zum Aufbau im Logfile)
...

CCEDAPI_CHECKSERVICESINTERFACE

Veranlasst den Enterprise Daemon dazu alle Services Schnittstellen zu prüfen. Dies geschieht asynchron.

Parameter	Hinweis
Result	true

CCEDAPI_STOPSERVICE

Stoppt den angegebenen Dienst - Rückgabe erfolgt erst wenn der Dienst beendet wurde oder ein Fehler vorliegt.

Parallel dazu kann der Dienststatus oder die Dienstübersicht abgerufen werden (bez. Stop-Pending Info etc.).

Benötigt als Url Parameter token=<InstanceToken>.

Parameter	Hinweis
Result	true/false

CCEDAPI_STARTSERVICE

Startet den angegebenen Dienst - Rückgabe erfolgt erst wenn der Dienst gestartet wurde oder ein Fehler vorliegt.

Parallel dazu kann der Dienststatus oder die Dienstübersicht abgerufen werden (bez. Start-Pending Info etc.).

Benötigt als Url Parameter token=<InstanceToken>.

Parameter	Hinweis
Result	true/false

CCEDAPI_GETLICENSEINFO

Liefert die Basis-Lizenzinformationen zurück (es können n Lizenzen zurückgeliefert werden).

Parameter	Attribut	Hinweis
License	Id	Lizenznummer
	Vendor	Hersteller-Firma
	Distributor	Distributor-Firma
	Partner	Partner-Firma
	Licensee	Lizenznehmer (Endkunde)
	Info	Lizenzinformationen
	Location	Ort
	Country	Land
	Creation	Erstellungsdatum (TimeStamp)
	Validity	Gültigkeitsdatum (TimeStamp)
	Activated	Lizenz aktiviert (bool)
	ActivationAvail	Lizenzaktivierung möglich (bool)
	Modules	Anzahl der Module
	Mode	Lizenzmodus (Internal, Demo, DemoVM oder Default)
...

CCEDAPI_GETLICENSEMODULES

Liefert eine Übersicht zu allen lizenzierten Modulen und deren Status zurück.

Parameter	Attribut	Hinweis
<ModulName>	Licenses	Anzahl der Lizenzen (gesamt)
	Free	Verfügbare (freie) Lizenzen
	Validity	Gültigkeit des einzelnen Moduls (TimeStamp)
	Maintenance	Wartung für das Modul (bool) - derzeit nicht verwendet
	MajorVersion	Versionsnummer (Major)
	MinorVersion	Versionsnummer (Minor)
	LicNumber	Lizenzzugehörigkeit / Lizenznummer (Id s.o.)
...

CCEDAPI_GETLICENSESESSIONS

Liefert eine Übersicht zu allen aktiven Lizenzsitzungen zurück.

Die Funktion benötigt als Url Parameter module=<Modulname>.

Parameter	Attribut	Hinweis
Session	User	Benutzer
	Computer	Client-Rechner
	IP	Von welchem Rechner kam die Lizenzanfrage (IP)
	Build	Versionsnummer der Client-Anwendung
	Registration	Startdatum/Uhrzeit der Sitzung (TimeStamp)
...

CCEDAPI_REFRESHPERMISSIONS

Aktualisiert die Berechtigungen (derzeit den ASE Service).

Parameter	Hinweis
Result	true/false

CCEDAPI_REFRESHSERVICES

Aktualisiert alle Services (analog zum Refresh Button im c4).

Es wird jedoch nicht auf die Fertigstellung der Aktualisierung gewartet. Das kann jedoch rein mit c4 Mitteln realisiert werden.

Parameter	Hinweis
Result	true/false