Technik:CoPlanner Installation: Quick Guide
Hier wird die Installation eines CoPlanners in Kurzform beschrieben.
Erstinstallation
Voraussetzungen
In dieser Beschreibung wird vorausgesetzt
- Es gibt einen Server/VM auf die zugegriffen werden kann
- Auf diesem System ist ein SQL Server installiert
- CoPlanner Software und CoPlanner Modell wurde von CoPlanner zur Verfügung gestellt
Benutzer
Es empfiehlt sich für den laufenden CoPlanner Betrieb zumindest zwei Domänenbenutzer anzulegen. Die Namen sind frei wählbar, exemplarisch werden in diesem Dokument folgende Benutzer verwendet:
- DOMAIN\COPSERVICE: Das ist der Benutzer unter dem der CoPlanner Dienst am Applikationsserver läuft.
- DOMAIN\COPUSER: Dieser Benutzer wird für Fernwartungszugriffe auf den Applikationsserver verwendet. Sollten personengebunden Benutzer angelegt werden, so sind für alle dieselben Berechtigungen zu setzen
CoPlanner Software
Die CoPlanner Software befindet sich in einer gezippten Datei. Der Name setzt sich hier immer aus der Version und dem Hotfix zusammen. z.B. CoP10 HF1.1.zip
- Das noch gezippte Archiv mit Rechtsklick/Eigenschaften -> Unblock entblocken
- Das Verzeichnis entpacken
Es gibt nun eine Verzeichnisstruktur, die folgende Ordner enthält:
- benoetigteKomponenten
- Clients
- Reporting
- ReportServer
- Server
- Tools
In den Ordner Tools gehen und "Rename_Configs.bat" ausführen.
CoPlanner Modell
Das CoPlanner Modell setzt sich aus einer Datenbank und den folgenden Ordnern zusammen:
- Analyze Objects (Definitionen der CoPlanner Würfel)
- Design (Formatvorlagen)
- DimensionSettings (Einstellungen zu den Dimensionen)
- Jobs (Abos des Abomanagers)
- Transfer (Definitionen der Importe)
- Upload (Dateien welche über Importe importiert werden)
Ab CoP 10 sind diese Ordner obsolet:
- Aggmasken (Definitionen des Typs Aggmasken)
- Berichte (altes PDF-Reporting in der Objektverwaltung)
Das Modell wurde ebenfalls über ein .zip File zur Verfügung gestellt. Bitte extrahieren Sie dieses in einem getrennten Ordner.
Datenbank einspielen
Am SQL Server muss die im CoPlanner Modell vorhandene Datenbank eingespielt werden.
Dazu einfach im SQL Server das Backup wiederherstellen (weitere Infos zur Wiederherstellung finden Sie hier).
Auf der Datenbank müssen Rechte für die Benutzer vergeben werden. Nähere Informationen dazu finden Sie hier.
Ordner einspielen
Die oben genannten Ordner müssen in den Ordner Server der Software kopiert werden.
Lizenz
In den Ordner Tools\LicenceKeyGenerator wechseln und die "CopLicenceKeyGenerator91.exe" ausführen.
Dadurch wird im Ordner folgende Datei erstellt: CoPlannerLicKey91.key.
Diese Datei muss der Firma CoPlanner zur Verfügung gestellt werden, damit das Lizenzfile erstellt werden kann.
Die Firma CoPlanner erstellt daraufhin das Licencefile („xxx.lic“). Diese muss im Ordner Server abgelegt werden und die LicenceID (Nummer der Lizenz) in die Datei Technik:CoPlanner-Server#SvrConfig.xml eingetragen werden.
Eine ausführlichere Beschreibung finden Sie hier.
Konfiguration
Server
Wechseln Sie in das Serververzeichnis und öffnen das Konfigurationsprogramm SvrConfig.exe.
Hier werden nur die notwendigsten Konfigurationen erwähnt. Weitere Konfigurationsmöglichkeiten finden Sie hier.
CopSettings
| Eintrag | Beschreibung | Beispiel | ||||||||||
| ConnectionString |
|
Server=meinsqlserver;Initial Catalog=COP_meinFirmenname;Integrated Security=SSPI;pooling=false | ||||||||||
| PortNumber | Bis CoP 10 HF 1.2: Freigegebene und nicht verwendete Portnummer für die Kommunikation des CoPlanner-Servers mit den CoPlanner-Clients. | 8963 | ||||||||||
| ServiceName | Name des CopService | copService | ||||||||||
| TelnetDebugPort | Es ist möglich, mittels Telnet ein Sichtfenster zum CoPlanner-Service aufzubauen. Dieser Eintrag legt die Portnummer für die Telnetverbindung fest. Die Verbindung erfolgt durch die DOS-Eingabeaufforderung (Start  Ausführen cmd). Zum Aufruf der Verbindung geben Sie: telnet rechnername portnummer (Bsp: telnet hostname 6900) ein und drücken auf Return.
|
6900 | ||||||||||
| LicenceID | Wird zwingend für den Start des CoPlanner Servers benötigt. Siehe Abschnitt Lizenz. | 1234 | ||||||||||
| SSPIPort | Bis CoP 10 HF 1.2: Port bzw. Portrange für die SSPI-Login Kommunikation zwischen CoPlanner Client und CoPlanner Server. Darf von der Firewall nicht geblockt werden. | 11000-11100 | ||||||||||
| ServerLogPath | Pfad und Verzeichnis um Logfiles zu speichern. Ist der Eintrag nicht vorhanden bzw. die Value leer, wird das CoPlanner Serververzeichnis für die Ablage der Logfiles verwendet. Ist ein gültiges Verzeichnis eingetragen, erfolgt die Anlage der Dateien in dem definierten Verzeichnis. Ist der Pfad ungültig, wird dies am Server beim Start ausgegeben, das Schreiben in die Log Datei wird deaktiviert. Lautet der Eintrag "NoLog", wird das Schreiben bzw. Erstellen der Log-Datei ebenfalls deaktiviert. Der User unter dem der CoPlanner Dienst läuft muss entsprechende Schreiberechte besitzen. |
D:\meinCoPlannerVerzeichnis\Server\Logs | ||||||||||
| MaxSvrLogFileSize | Die maximiale Größe welche die Serverlog-Files erreichen können. Wird diese Größe überschritten, wird diese Datei komprimiert und in ein Archiv-Verzeichnis verschoben. Null bedeutet keine Komprimierung. Die Konfiguration erfolgt in KB. | 10000 |
WebConfig
Folgende Punkte müssen im Bereich WebConfig definiert werden:
| Eintrag | Beschreibung | Beispiel | ||
| WebAppUrl | Zwingend erforderlich ab CoP 10 HF 1.2: Definiert die Basis-URL unter welcher der interne Webserver verfügbar ist, über welchen die komplette Kommunikation erfolgt.
|
https://+:4443/coplanner | ||
| ReportServerUrl | URL über die mit dem Repotserver kommuniziert werden kann. Nur notwendig, wenn das Webreporting im Einsatz ist. Die URL muss der reportServerUrl im Programm ReportSvrConfig.exe (s.u.) entsprechen.
|
https://myserver.com:4444/coplanner/reporting |
ReportServer
Wechseln Sie in das ReportServer-Verzeichnis und öffnen das Konfigurationsprogramm ReportSvrConfig.exe.
HTTPsREST
| Eintrag | Beschreibung | Beispiel | |
| reportServerUrl | URL über welche der Reportserver kommuniziert
|
https://+:4444/coplanner/reporting | |
| CopServerServiceName | Name, unter welchem das CoPlanner Service läuft (siehe Eintrag ServiceName in der svrconfig im Server). Dient nur dazu, um bei der Service-Installation dann eine Abhängigkeit auf das CoPlanner Service zu setzen. Soll es keine Abhängigkeit geben, kann der Eintrag einfach leer gelassen werden. | CopService | |
| ReportServerServiceName | Name, unter welchem das ReportServer Service angelegt werden soll. | CopReportingService | |
| ReportServerLogPath | Ist kein Pfad angegeben, so wird das Logfile unter dem angegebenen Namen angelegt. Es kann hier auch vorne noch ein Pfad hinzugefügt werden. | CopReportServer.log | |
| EventsUrl | Hier muss die ReportServerUrl, wobei das + mit dem entsprechenden Namen oder IP-Adresse ersetzt sein muss, erweitert mit api/v1.0/events stehen | ||
| CopServerUrl | URL über die mit dem CoPlanner Server/Service kommuniziert werden kann. | ||
| MaxRows | Ab CoP 10 HF 1.2: Dies ist die Anzahl der Datensätze, die maximal vom CoPlanner Server empfangen werden kann. Diese sollte in Relation zur Leistung des Client-Rechners stehen. Wird beim Laden von Datensätzen in einer Eingabemaske die hier festgelegte maximale Datensatzanzahl überschritten, wird der Ladevorgang unterbrochen und eine Meldung ausgegeben, die auffordert, die Datenmenge mittels Filtern entsprechend einzuschränken. | ||
| MaxCells | Ab CoP 10 HF 1.2: Gibt an, wie viele Zellen (Produkt der Achsendimensionselemente) maximal vom CoPlanner Server geladen werden. Ist dieser Tag nicht vorhanden, oder wird 0 eingetragen, erfolgt keine Einschränkung. |
ClientConfig
Ab CoP 10 HF 1.2 nicht mehr erforderlich.
| Eintrag | Beschreibung | Beispiel |
| Server | Servername oder IP-Adresse des Systems, auf dem der CoPlanner Server bzw. Service läuft | myservername |
| Port | Port unter dem der CoPlanner Server bzw. Service läuft (siehe Eintrag PortNumber in der svrconfig im Server) | 8963 |
SessionSettings
Ab CoP 10 HF 1.2 nicht mehr erforderlich.
| Eintrag | Beschreibung | Beispiel |
| User | Der hier angegebene User muss in der CoPlanner Benutzerverwaltung angelegt werden und Rechte auf dem bei Entity angegebenen Unternehmen haben und auf dem angegebenen Plan. | myReportserverUser |
| Password | Passwort zum verwendeten Benutzer. Ist der Benutzer, unter welchem der CoPlanner Reportserver ausgeführt wird in der Benutzerverwaltung vorhanden, so kann hier auch SSPI angegeben werden um sich mit SSPI zu identifizieren. | myPassword |
| Entity | Name des Unternehmens, über das eine Verbindung zum CoPlanner Server hergestellt wird. | Unternehmen |
| Plan | Name des Plans, über das eine Verbindung zum CoPlanner Server hergestellt wird. | Budget 2019 |
Weitere Konfigurationsmöglichkeine finden Sie hier.
Clients
Windows
Gehen Sie in das Verzeichnis Clients\Windows. Öffnen Sie dort die ClientConfig.xml in einem Texteditor.
ClientConfig
| Eintrag | Beschreibung | Beispiel |
| Serverurl | URL unter der der CoPlanner Server erreichbar ist | https://meinzugriffsname:4443/coplanner |
Weitere Konfigurationsmöglichkeine finden Sie hier.
ClientConfig vor CoP 10 HF 1.2
| Eintrag | Beschreibung | Beispiel |
| Server | Servername oder IP-Adresse des Systems, auf dem der CoPlanner Server bzw. Service läuft | myservername |
| Port | Port unter dem der CoPlanner Server bzw. Service läuft (siehe Eintrag PortNumber in der svrconfig im Server) | 8963 |
Weitere Konfigurationsmöglichkeine finden Sie hier.
Installieren der Services
CoPlanner Service
- Aufruf der SvrConfig.exe im Serverordner
- Button 'Install Service' links unten klicken
- Eingeben des Benutzers, unter dem das Service laufen soll (z.B. DOMAIN\COPSERVICE)
Das Service wurde damit erstellt.
Notwendige Schritte für die Verwendung von https
Für die Bindung des SSL Zertifikats muss folgender Befehl als Administrator in der Konsole ausgeführt werden
netsh http add sslcert ipport=0.0.0.0:<Portnummer> certhash=<fingerprint> appid=<GUID>
| Parameter | Beschreibung |
| Portnummer | Portnummer, welche in der WebAppUrl verwendet wird. z.B. bei WebAppUrl https://+:4443/coplanner wäre das 4443 |
| certhash | Fingerabdruck des Zertifikats. Dieser ist in den Details des Zertifikats zu finden und muss hier ohne den Leerzeichen angegeben werden. |
| GUID | Die GUID unterscheidet sich, ob der CoPlanner als Server oder als Service verwendet wird
|
Beispiel: netsh http add sslcert ipport=0.0.0.0:4443 certhash=2170950415ef045f6cb314c92e124411dd0590bf appid={82880fad-ad78-4531-99ba-533f4c8e5840}
CoPlanner Reporting Service
- Aufruf der ReportSvrConfig.exe im ReportServer-Ordner
- Button 'Install Service' links unten klicken
- Eingeben des Benutzers, unter dem das Service laufen soll (z.B. DOMAIN\COPSERVICE)
Das Service wurde damit erstellt.
Notwendige Schritte für die Verwendung von https
Für die Bindung des SSL Zertifikats muss folgender Befehl als Administrator in der Konsole ausgeführt werden
netsh http add sslcert ipport=0.0.0.0:<Portnummer> certhash=<fingerprint> appid=<GUID>
| Parameter | Beschreibung |
| Portnummer | Portnummer, welche in der reportServerUrl verwendet wird. z.B. bei reportServerUrl https://+:4444/coplanner/reporting wäre das 4444 |
| certhash | Fingerabdruck des Zertifikats. Dieser ist in den Details des Zertifikats zu finden und muss hier ohne den Leerzeichen angegeben werden. |
| GUID | Die GUID unterscheidet sich, ob der Reportserver als Konsole oder als Service verwendet wird
|
Beispiel:
netsh http add sslcert ipport=0.0.0.0:4444 certhash=2170950415ef045f6cb314c92e124411dd0590bf appid={d36681ea-e3d6-4909-94c3-93834beddb9d}
Überprüfung der Installation
- Starten Sie das CoPlanner Service über die Dienste und starten Sie das Telnet mit dem TelnetDebugPort, den Sie in der SvrConfig angegeben haben.
- Warten Sie bis der Server hochgefahren ist. Das erkennen Sie an den Ausgaben 'Server started successfully!' und 'Http Server listening on https://+:4443/coplanner'
Erhalten Sie diese Meldungen nicht, stimmt etwas an der Serverkonfiguration nicht und Sie sollten dann entsprechende Fehlermeldungen erhalten
- Wechseln Sie in das Client\Windows-Verzeichnis und starten Sie die coplanner.exe
Sie sollten hier ein Anmeldefenster bekommen. Erhalten Sie kein Anmeldefenster prüfen Sie bitte die ClientConfig.xml in diesem Verzeichnis, ob die Portnummer und der Servername stimmen.
- Starten Sie das CoPlannerReportServer-Service über die Dienste
Prüfen Sie im Logfile, ob Sie die Meldung 'Verbindung zum CoPlanner Server hergestellt' erhalten. Sofern Sie diese Meldung nicht erhalten, gibt es ein Problem mit der Konfiguration und Sie sollten eine entsprechende Meldung sehen.
Nachträgliches ändern der WebAppUrl
Wird die WebAppUrl in der svrconfig.xml nachträglich geändert, müssen folgende Schritte ausgeführt werden:
Console als Administrator ausführen und folgende Schritte ausführen:
Entfernen des alten Eintrags
netsh http delete urlacl url=<alteWebAppUrl>
z.B.:
netsh http delete urlacl url=https://+:4444/coplanner
Hinzufügen des neuen Eintrags
Beispiel:
netsh http add urlacl url=<WebAppUrl> user=<DOMAIN\user>
netsh http add urlacl url=https://+:4443/coplanner user=DOMAIN\COPSERVICE
Notwendige Schritte bei der Verwendung von https
Löschen des bestehenden Eintrags
netsh http delete sslcert ipport=0.0.0.0:<altePortnummer>
altePortnummer: Portnummer welche in der bestehenden WebAppUrl verwendet wurde. z.B. bei WebAppUrl https://+:4443/coplanner wäre das 4443
Beispiel: netsh http delete sslcert ipport=0.0.0.0:4443
Hinzufügen des neuen Eintrags
netsh http add sslcert ipport=0.0.0.0:<Portnummer> certhash=<fingerprint> appid=<GUID>
| Parameter | Beschreibung |
| Portnummer | Portnummer, welche in der WebAppUrl verwendet wird. z.B. bei WebAppUrl https://+:4443/coplanner wäre das 4443 |
| certhash | Fingerabdruck des Zertifikats. Dieser ist in den Details des Zertifikats zu finden und muss hier ohne den Leerzeichen angegeben werden. |
| GUID | Die GUID unterscheidet sich, ob der CoPlanner als Server oder als Service verwendet wird
|
Beispiel: netsh http add sslcert ipport=0.0.0.0:4443 certhash=2170950415ef045f6cb314c92e124411dd0590bf appid={82880fad-ad78-4531-99ba-533f4c8e5840}
Nachträgliches ändern der ReportServerUrl
Wird die ReportServerUrl in der Datei ReportSvrConfig.xml nachträglich geändert, müssen folgende Schritte ausgeführt werden:
Anpassen der ReportServerUrl in der svrconfig.xml im Serverordner.
Console als Administrator ausführen und folgende Schritte ausführen:
Entfernen des alten Eintrags
netsh http delete urlacl url=<alteReportServerUrl>
z.B.:
netsh http delete urlacl url=https://+:4444/coplanner/reporting
Hinzufügen des neuen Eintrags
Beispiel:
netsh http add urlacl url=<ReportServerUrl> user=<DOMAIN\user>
netsh http add urlacl url=https://+:4444/coplanner/reporting user=DOMAIN\COPSERVICE
Notwendige Schritte bei der Verwendung von https
Löschen des bestehenden Eintrags
netsh http delete sslcert ipport=0.0.0.0:<altePortnummer>
altePortnummer: Portnummer welche in der bestehenden ReportServerUrl verwendet wurde. z.B. bei ReportServerUrl https://+:4444/coplanner/reporting wäre das 4444
Beispiel: netsh http delete sslcert ipport=0.0.0.0:4444
Hinzufügen des neuen Eintrags
netsh http add sslcert ipport=0.0.0.0:<Portnummer> certhash=<fingerprint> appid=<GUID>
| Parameter | Beschreibung |
| Portnummer | Portnummer, welche in der ReportServerUrl verwendet wird. z.B. bei ReportServerUrl https://+:4444/coplanner/reporting wäre das 4444 |
| certhash | Fingerabdruck des Zertifikats. Dieser ist in den Details des Zertifikats zu finden und muss hier ohne den Leerzeichen angegeben werden. |
| GUID | Die GUID unterscheidet sich, ob der CoPlanner als Server oder als Service verwendet wird
|
Beispiel: netsh http add sslcert ipport=0.0.0.0:4444 certhash=2170950415ef045f6cb314c92e124411dd0590bf appid={d36681ea-e3d6-4909-94c3-93834beddb9d}
