Administrationshandbuch - MyControl® Workflow...

1

AdministrationshandbuchMyControl® Workflow Server

$Revision: 1.32 $

Copyright © 2005-2011 MyControl® GmbH

Inhaltsverzeichnis1. Einführung .............................................................................................................................. 1

1.1. Filterfunktionen im Administrationsbereich ..................................................................... 22. Allgemeines ............................................................................................................................ 2

2.1. Nachschlagetabellen .................................................................................................... 22.2. Konfiguration ................................................................................................................ 42.3. Update ......................................................................................................................... 52.4. Logfile ......................................................................................................................... 6

3. Benutzer und Rechte .............................................................................................................. 63.1. Ändern des Administrationspasswortes ......................................................................... 63.2. Anlegen weiterer Benutzer ............................................................................................ 73.3. Anlegen von Projektrechten .......................................................................................... 83.4. Gruppenrechte ............................................................................................................. 83.5. Rechte ......................................................................................................................... 9

4. Workflows ............................................................................................................................. 104.1. Workflows importieren ................................................................................................ 104.2. Workflows anlegen ..................................................................................................... 104.3. Workflows editieren .................................................................................................... 104.4. Suchkategorien .......................................................................................................... 114.5. Projektrollen ............................................................................................................... 12

4.5.1. Automatische Projektrollen-Verteilung ............................................................... 125. Abrechnung .......................................................................................................................... 12

5.1. Abrechnungsarten ...................................................................................................... 125.2. Dienstleistungen ......................................................................................................... 135.3. Artikel ........................................................................................................................ 145.4. Preislisten .................................................................................................................. 145.5. Druckvarianten ........................................................................................................... 14

A. Systemvoraussetzungen ....................................................................................................... 15B. Installationsanleitung, Teil I ................................................................................................... 15C. Installationsanleitung, Teil II .................................................................................................. 17D. betriebssystemabhängige Installationsanleitungen .................................................................. 18E. Installationsanleitung Fax-Gateway Sipgate ........................................................................... 19F. Springloops SVN post-commit Hooks ..................................................................................... 20G. Upgrade auf eine neue WFS Version .................................................................................... 20

1. EinführungHerzlich Willkommen zum MyControl Workflow Server, der Weblösung für effizientes undprofessionelles Arbeiten. Wir freuen uns, dass Sie sich für Software aus dem Hause MyControlentschieden haben und sind sicher, dass wir Ihnen ein ausgereiftes und gutes Programm an die Handgeben. Sollten Sie Verbesserungsvorschläge oder Anregungen haben, würden wir uns über eine kurzeNachricht sehr freuen. Verwenden Sie hierfür den Menüpunkt "Feedback" am oberen Bildschirmrand.

Alle beschriebenen Konfigurationsmöglichkeiten finden Sie nach dem Login in der Statusleiste unterdem Menüpunkt Administration. Es öffnet sich ein neues Browserfenster mit der Administrations-Oberfläche:

Administrationshandbuch

2

1.1. Filterfunktionen im Administrationsbereich

In allen Listen, die im Administrationsbereich angezeigt werden, können Sie filtern, sortieren undblättern:

Funktion Wird ausgeführt durch... Bemerkung

Filtern Eingabe eines Suchbegriffs in einEingabefeld im Spaltenkopf unddann Klick auf "filtern"

Gesucht wird nach Einträgen, diemit dem Suchbegriff beginnen

Löschen aller Filter Klick auf "clear"

Sortieren Klick auf einen Spaltentitel. Beim ersten Klick aufeine Spaltenüberschrift wirdaufsteigend sortiert, beimzweiten Klick absteigend.

Blättern Klick auf "Anfang", "Ende", "vor"und "zurück"

2. Allgemeines

2.1. Nachschlagetabellen

Klicken Sie im Administrationsmenü auf Nachschlagetabellen. Es erscheint eine Liste der vorhandenenTabellen:


3

Tabelle Beschreibung

Kontaktarten Im Workflow Server können Sie zu Kunden eineKontakt-History ablegen. Jeder dieser Kontaktehat eine Kontaktart wie z.B. "Telefonat" oder"Besuch". In dieser Tabelle sind alle auswählbarenKontaktarten hinterlegt

Kundenbewertung Zur Bewertung und Unterscheidung von Kundenund Interessenten hat der Workflow Server einFeld Kundenbewertung. In dieser Tabelle könnenSie die möglichen Bewertungen ändern.

Adresstypen Um Typen verschiedener Adressen zuunterscheiden, können Sie hier Gruppenanlegen. (z.B. Endverbraucher, Wiederverkäufer,Lieferanten).

Kategorien für Ansprechpartner Sie haben die Möglichkeit, Ansprechpartnern eineoder mehrere Kategorien zuzuordnen, nach eineSelektion möglich ist. Die möglichen Kategorienwerden hier verwaltet.

Abteilungen Verwalten Sie hier die Abteilungen IhresUnternehmens. Sie können Mitarbeiter zuAbteilungen zuordnen und beispielsweise in derDisposition danach filtern.

Nachschlagetabellen Hier können Sie eigene Nachschlagetabellenanlegen und verwalten. Diese können Sieverwenden, um in Formularen Drop-Down-Felderzu füllen.

Nach Auswahl der gewünschten Nachschlagetabelle können Sie in dieser ändern, Einträge löschenoder neue Einträge anlegen:


4

2.2. Konfiguration

In diesem Menüpunkt können Sie verschiedene Konfigurationsvariablen für den Workflow Serversetzen. Folgende Variablen sind definiert:

Variable Beschreibung

invoice.bcc Beim Versenden von PDF-Rechnungen per E-Mailwird immer einen Kopie der Rechnung an die hierhinterlegte E-Mail-Adresse gesendet.

invoice.head Standardkopftext bei Rechnungen

invoice.foot Standardfusstext bei Rechnungen

invoice.payment Standardzahlungsbedingungen bei Rechnungen


5

2.3. Update

Updates für den WFS werden regelmässig von MyControl herausgegeben. Informationen über Ihreaktuellen Version und das nächste geplante Update erhalten Sie auf der WFS-Update-Seite (s.u.).

Updates, die Fehler in der aktuellen Version beheben, werden automatisch von einem MyControl Serverper Internet heruntergeladen und auf Ihrem System installiert, sofern die CVS-Kontrolle verfügbar ist.Ein Eingriff durch den Benutzer ist dazu nicht erforderlich. Ankündigungen oder Benachrichtigungenfinden nicht automatisch statt und es werden dabei keine Daten an MyControl übermittelt. Auf dieseWeise werden Software-Bugs sofort nach dem Bekannwerden behoben und Ihr WFS pflegt sich vonselbst.

Neue Versionen (Release) mit neuen Funktionen werden bei ASP Kunden vom ASP-Anbieter installiert,bei Enterprise-Installationen müssen diese Updates mit der WFS-Update-Funktion durchgeführtwerden, können optional aber auch automatisch passieren.

Hot-Updates: Updates im WFS werden im laufenden Betrieb durchgeführt. Zu Ausfallzeiten kommt esdabei nicht.

Tabelle 1. Informationen auf dieser Seite

Software-Version Version Ihres WFS (z.B. Version 4.6.1)

CVS Kontrolle Ja für automatische Bug-Updates, Nein für offline-Installation

Version des CVS entspricht der Software-Version (z.B. REL461)

Updates verfügbar zeigt an, ob ein Update (neuer Release) verfügbarist

Update-Rechte zeigt an, ob Ihre Installation es erlaubt, das Updatedurchzuführen

Nächster Release Version des nächsten geplanten Releases

geplant für Datum des nächsten geplanten Releases


6

Projektstatus Status des nächsten geplanten Releases(Entwicklung -> Test -> Release)

Info Informationen dazu

2.4. Logfile

Im Logfile sehen Sie Ergebnisse von wfScript-Operationen. Sofern ein wfScript einen Fehler oderDebugoutput ausgibt, wird hier ein Eintrag erzeugt. Sie sollten das Logfile regelmässig prüfen undlöschen, damit das Logfile nicht zu gross wird. Verwenden Sie hierfür den Button Leeren.

3. Benutzer und Rechte

3.1. Ändern des Administrationspasswortes

Um Ihren Workflow Server vor unbefugtem Zugriff zu schützen, sollten Sie als erstes dasAdministratorpasswort ändern. Wählen Sie hierzu Benutzer aus dem Menü links und klicken dann aufdie Zeile mit dem Benutzernamen admin.

Um das Passwort dieses Benutzers zu ändern, geben Sie das neue Passwort zweimal in die FelderKennwort und Kennwort Wiederholung ein und klicken auf Speichern. Notieren Sie sich Ihr neuesPasswort gut und bewahren Sie es an einem sicheren Ort auf.

Wichtig

Zu keinem Zeitpunkt werden Sie Mitarbeiter von MyControl nach Ihrem Passwort fragen.Halten Sie Ihr Administratorpasswort geheim und sicher und beantworten Sie Fragendanach nicht.


7

3.2. Anlegen weiterer BenutzerDen Account des Benutzers admin sollten Sie ausschließlich für Administrationszwecke verwenden.Legen Sie deshalb zunächst einen oder mehrere andere Benutzer an.

Klicken Sie hierzu im Administrationsmenü auf Benutzer und dann auf Neu am Ende der Liste. FolgendeDaten können Sie eingeben:

Feld Beschreibung

Login Dies ist der Loginname des Benutzers. Dieser wirdzur Anmeldung am System und als Kürzel fürden Benutzer ("Handle") innerhalb der Applikationverwendet. Vergeben Sie dieses Feld sorgfältig,Sie können es nachträglich nicht mehr ändern!

Nachname, Vorname Den Namen kann ein Benutzer nicht selbständern, dies kann nur der Administrator in derBenutzerverwaltung.

Kennwort, Kennwort Wiederholung Um Falscheingaben zu vermeiden müssen Sie dasKennwort zweimal eingeben.

Kunde Lassen Sie dieses Feld bei Benutzern in IhremUnternehmen leer. Wenn Sie später KundenZugriff auf den Workflow Server ermöglichenmöchten, hat dieses Feld eine Bedeutung.

Lohnabrechnung Soll für diesen Benutzer eine monatlicheStundenabrechnung erstellt werden?

Eigener Mitarbeiter Ist dieser Benutzer ein Mitarbeiter IhresUnternehmens? Dieses Feld steuert die Anzeige


8

Feld Beschreibungvon Benutzern für die Funktion Auslastung. Dortwerden Ihnen nur Mitarbeiter Ihres Unternehmensangezeigt.

Firma Die Firma des Benutzers (wird auf der Benutzer-Visitenkarte angezeigt)

Smart Card Identifikation (für fortgeschritteneBenutzer)

Sofern Sie die Option „Anmeldung mittelsSmartCard“ des Workflow Server verwenden,können Sie hier Kartenidentifikation des Benutzersangeben.

Gruppen Wählen Sie die gewünschten Gruppen aus,in denen der Benutzer Mitglied sein soll. DieMitgliedschaft in einer Gruppe gewährt demBenutzer die damit verbundenen Zugriffsrechte.Standardmäßig ist nur eine Gruppe eingerichtet:Administrator (alle Rechte). Später werden Sieverschiedene Gruppen mit unterschiedlichenRechteprofilen anlegen.

Klicken Sie auf „Speichern“ um den Benutzer anzulegen. Sie gelangen auf die Übersichtsseite derBenutzer. Um zu überprüfen, ob alle Eingaben korrekt übernommen wurden, klicken Sie auf den neuenBenutzer. Sie bekommen seine Daten angezeigt.

3.3. Anlegen von ProjektrechtenDas Rechtesystem des Workflow Server besteht aus zwei Komponenten: Funktions- undProjektrechten. Über die Zuordnung von Gruppen bestimmen Sie, auf welche Funktionen ein BenutzerZugriff erhalten soll. Um einzelnen Benutzern nur Zugriffe auf bestimmte Projekte zu ermöglichen,verwenden Sie Projektrechte.

Der neu angelegte Benutzer soll auf alle Projekte zugreifen können, deshalb weisen wir Ihmentsprechende Projektrechte zu:

1. Klicken Sie auf Neu unterhalb der Projektrechte

2. Geben Sie im Feld Handle %:% ein, was "Alle Projekte" bedeutet.

3. Klicken Sie auf Speichern.

3.4. GruppenrechteZur Verwaltung von Funktionsrechten können Benutzer Mitglied in einer oder mehr Gruppen haben.Diesen Gruppen sind wiederum Rechte zugeordnet, die den Zugriff des Benutzers auf bestimmteFunktion erlauben. Ist ein Benutzer Mitglied in mehreren Gruppen, erhält er alle Berechtigungen allerseiner Gruppen.


9

Im Auslieferungszustand enthält der Workflow-Server nur eine Gruppe: Administratoren. Um abgestufteBerechtigungen zu vergeben, können Sie weitere Gruppen mit geringeren Berechtigungen anlegen. Zujeder Gruppe können Sie die gewünschten Berechtigungen auswählen.

Zu jedem Recht wird Ihnen eine Beschreibung angezeigt. Nachfolgend einige Tipps zu besonderenoder wichtigen Rechten:

Recht Beschreibung

admin Zugriff auf den Menüpunkt Administration

browse Zugriff auf den Projektbrowser (bei Auswahl …andere Projekte in der Projektliste). Benutzer ohnedieses Recht können den Projektbrowser nichtbenutzen, keine Projektnamen händisch eingebensondern bekommen eine Liste aller Ihrer Projektezur Auswahl dargestellt.

nav.mgmt nav.misc nav.overview nav.tasks Über dieses Rechte können Sie ganzeFunktionsgruppen ein- bzw. ausblenden:

nav.mgmt Funktionsgruppe"Projektmanagement"

nav.overview Funktionsgruppe "Übersicht"

nav.tasks Funktionsgruppe "Aufgaben"

task.search.own Dieses Recht gibt an, ob der Benutzer seineeigenen Aufgaben ansehen kann. Normalerweisesollte jeder Benutzer dieses Recht haben.

task.typechange Benutzer ohne dieses Recht können nur Aufgabenim "Standardworkflow" anlegen.

wf.* Die mit wf. beginnenden Rechte gehören zuden von Ihnen verwendeten Workflows undsteuern dort die Berechtigung zu einzelnenStatusänderungen.

3.5. RechteHier können Sie neue Rechte im System anlegen. Dies ist insbesondere bei der Verwendung desIntranet-Systems Wiki hilfreich:


10

Wenn Sie bestimmte Wiki-Seiten (z.B. interne Informationen der Personalabteilung) nur für einigeBenutzer zugänglich machen möchten, gehen Sie wie folgt vor:

1. Legen Sie ein neues Recht an in der Art wiki.xxx (z.B. wiki.personal)

2. Weisen Sie dieses Recht einer Gruppe zu (z.B. Personalabteilung)

3. Stellen Sie sicher, dass alle Benutzer, die zugriffsberechtigt sein sollen, Mitglied dieser Gruppe sind.

4. Editieren Sie die zu schützende Seite und wählen Sie bei Recht zum Lesen und „Recht zum Editierendas neu angelegte Recht aus.

4. WorkflowsEine allgemeine Einführung zum Thema Workflow finden Sie im Benutzerhandbuch.

Nähere Informationen zur Neuanlage und Bearbeitung von Workflows und Formularen finden Sie imHandbuch für Workflow Entwickler.

Als Administrator können Sie die Workflows in Ihrem WFS mit den in diesem Kapitel beschriebenenFunktionen verwalten.

4.1. Workflows importieren

Workflows im XML-Format können Sie als Datei oder von einer Internet-Adresse importieren.

Wählen Sie entweder die Workflow-XML-Datei auf Ihrem Rechner aus oder geben Sie die URL zu einergültigen Datei an.

Workflows im XML-Format stellt Ihnen MyControl zur Verfügung.

Nach dem Import ist ein neuer Workflow zunächst deaktiviert. Damit Ihre Benutzer damit arbeiten,müssen Sie den Workflow aktivieren.

Mit dem Import eines Workflows werden auch neue Rechte importiert. Überprüfen Sie deshalb nachdem Import in den Gruppenrechte, ob alle Benutzer die erforderlichen Berechtigungen besitzen.

Warnung

Der Import von bösartigen Dateien kann Ihre Datenbank beschädigen. Installieren Siedeshalb nur Workflows aus vertrauenswürdigen Quellen.

4.2. Workflows anlegen

Sie können selbst Workflows anlegen.

Vergeben Sie hierzu eine interne ID für den Workflow im Format workflow@domain also [email protected] und wählen Sie aus, ob Sie den Assistenten verwenden möchten undob ein bestehender Workflow als Vorlage herangezogen werden soll.

Weitere Informationen zum Workflow-Assistenten und Editor finden Sie im Handbuch für WorkflowEntwickler.

4.3. Workflows editieren

Als Administrator können Sie verschiedene Einstellung je Workflow vornehmen:


11

Feld Beschreibung

Aktiviert Nur aktivierte Workflows können als Grundlage fürneue Tasks verwendet werden. Wählen Sie Ja umdiesen Workflow zu aktivieren.

für Scan-Client aktiviert Gibt an, ob der Workflow für Taskanlage mit demScanner Client verwendet werden darf.

Formular zeigt an, ob diese Workflow Formulare benutzt

Projekt Standardprojekt für Tasks dieses Workflows(optional), benötigt für: neue Task ohne Projektanlegen und ScannerClient

4.4. SuchkategorienIm Workflow Server können Sie sich Aufgaben nach Kategorien anzeigen lassen. Welche Kategorienzur Auswahl angeboten werden, wird in diesem Menüpunkt eingestellt. Zum Anlegen einer neuenSuchkategorie klicken Sie auf Neu. Nun können Sie die Bezeichnung, das benötigte Recht und denSortierschlüssel angeben und in der unteren Tabelle die Darstellungskritierien auswählen.


12

4.5. Projektrollen

Bei individuell für Ihr Unternehmen entwickelten Workflows kommen die Projektrollen zum Tragen.Hierüber können Sie je Projekt steuern, welcher Benutzer bestimmte Aufgaben zugewiesen bekommt.Eine detaillierte Erläuterung dieser Funktion erhalten Sie zusammen mit Ihrem individuellen Workflow.

Der Button Automatisch öffnet die Abschnitt 4.5.1, „Automatische Projektrollen-Verteilung“.

4.5.1. Automatische Projektrollen-Verteilung

Auf dieser Seite bekommen Sie Vorschläge für Projektrollen-Einträge gezeigt.

Dazu werden Projekt, Benutzer und Rolle angezeigt und dazu der Prozentsatz, zu dem die Tasks diesesProjekts an den Benutzer in der Rolle gegeben wurden. Berücksichtigt werden dabei die letzten 4 Jahre..

Es werden nur Vorschläge mit mehr als 50% gemacht.

Um die Vorschläge, die angenommen und in die Projektrollen eingetragen werden sollen, anzunehmen,muss jeder Vorschlag am Anfang der Zeile angekreuzt werden. Beim Klick auf Übernehmen wird dieAuswahl übernommen.

5. Abrechnung

5.1. Abrechnungsarten

Der Workflow Server unterstützt Sie bei der Ermittelung abzurechnender Stunden. Zu diesem Zweckkönnen Sie zu jeder Aufgabe eine Abrechnungsart angeben, die bestimmt, wie die abzurechnendenStunden zu ermitteln sind. Zusätzlich können, sofern Sie einen individuellen Workflow verwenden, überdie Abrechnungsart bestimmte Besonderheiten im Arbeitsablauf angesteuert werden.


13

Die Felder der einzelnen Abrechnungsarten im Detail:

Feld Beschreibung

Name Der anzuzeigende Name dieser Abrechnungsart

Abrechnung Auf welche Weise soll die Anzahl derabzurechnenden Stunden ermittelt werden?

Aufwand Abrechnung mittels tatsächlichverbrauchter Zeit

Planzeit Abrechnung der Planzeit unabhängigvom tatsächlichen Aufwand

Kennzeichen SET (für fortgeschrittene Benutzer) Sofern Sie einen individuellen Workflowverwenden, können Sie hier zu setzendeKennzeichen angeben. Ansonsten lassen Sie dasFeld leer.

Kennzeichen DEL (für fortgeschrittene Benutzer) Sofern Sie einen individuellen Workflowverwenden, können Sie hier zu löschendeKennzeichen angeben. Ansonsten lassen Sie dasFeld leer.

Standard Diese Abrechnungsart soll als Standard bei derAnlage neuer Aufgaben verwendet werden. Eskann immer nur eine Standard-Abrechnungsartexistieren.

5.2. DienstleistungenUm geleistete Stunden nach Art der Tätigkeit auswerten zu können, können Sie verschiedensteDienstleistungsarten im System hinterlegen. Diese stehen Ihnen dann bei der Buchung von Stunden alsAuswahlmöglichkeit zur Verfügung. Zu jeder Dienstleistung kann ein Artikel definiert werden, welcherzur Abrechnung der Stunden dieses Typs verwendet wird. Weitere Informationen dazu finden Sie in derDokumentation der API-Methode invoice_autospool.


14

5.3. Artikel

Hier verwalten Sie Artikel des Workflow Servers.

Die hier definierten Artikel können die Benutzer beim Erstellen von Rechnungen verwenden.

Ein Artikel hat folgende Eigenschaften:

Feld Beschreibung

Name Der Name des Artikels, so wie er auch aufRechnungen erscheint.

Steuersatz Umsatzsteuersatz in Prozent für diesen Artikel

Einheit Masseinheit des Artikels, wie sie auf der Rechnungerscheinen soll (z.B. "h" oder "Stk.")

Die Preise von Artikeln werden in Preislisten festgelegt (siehe Abschnitt 5.4, „Preislisten“).

5.4. Preislisten

In diesem Menüpunkt können Sie eine oder mehrere Preislisten anlegen.

Jedem Kunden kann genau eine Preisliste zugeordnet werden.

Eine Preisliste kann für viele Kunden gelten.

Eine Preisliste enthält Preise (in Euro) für alle im System vorhandenen Artikel (siehe Abschnitt 5.3,„Artikel“).

5.5. Druckvarianten

Druckvarianten steuern, wie der Workflow Server eine Rechnung in ein PDF wandelt und versendet.Sie können beliebig viele Druckvarianten anlegen und diese dann Ihren Kunden (bei den Einstellungendes Kunden) zuweisen. Rechnungen an diesen Kunden werden dann immer mit der ausgewähltenDruckvariante erzeugt. Folgende Einstellungen können Sie je Druckvariante vornehmen:

Feld Beschreibung

Name Name der Druckvariante

XSLT Dateiname der XSLT-Datei im Verzeichnis data/xslt, mit welcher das PDF erzeugt werdensoll. Die XSLT-Datei steuert das Aussehenund genaue Layout der Rechnung. XSLT-Dateien müssen im Verzeichnis data/xslt abgelegtwerden. Standardmässig ist invoice-pdf.xslim Workflow Server enthalten. Um das Layout aufIhre Bedürfnisse anzupassen, kopieren Sie undpassen Sie diese Datei an.

Overlay PDF Dateiname einer PDF-Datei im Verzeichnis data/pdf, welche als "Briefpapier" über das erzeugtePDF gelegt wird. Enthält die verwendete PDF-Datei eine Seite, so wird diese hinter jede Seite dererzeugten Rechnung gelegt. Enthält die PDF-Dateizwei Seiten, so wird die erste Seite des Overlays


15

Feld Beschreibungfür die erste Seite der Rechnung verwendet unddie zweite Seite des Overlays für alle folgenden.

Mailtext Beim Versand der Rechnung per E-Mail wirddieser Text in der E-Mail verwendet.

A. SystemvoraussetzungenClient Mozilla Firefox ab Version 2

oder Microsoft Internet Explorer ab Version 7.0 oder höher

Erlaubte Popups, JavaScript aktiviert

Server Linux, FreeBSD und andere UNIX-Systeme

Apache ab Version 1.3 oder IIS ab Version 6

MySQL ab Version 5.0

Perl ab Version 5.8

CVS ab Version 1.11

Verschiedene CPAN-Module (siehe Installationsanleitung)

B. Installationsanleitung, Teil I1. Falls Sie kein CVS installiert haben: CVS Installation.

2. Installationen aus dem CVS:

Erstellen Sie eine working copy der aktuellen Release Version durch Checkout aus dem Repository.

Der Kommandozeilen-Befehl dafür lautet:

cvs -d:pserver:[email protected]:/data/myc:wfs checkout -rRELxxx -P wfs

Die Nummer des aktuellen Release finden Sie auf der Installations-Seite der Website (http://www.mycontrol.de/workflow/) oder mittels

cvs -d:pserver:[email protected]:/data/myc:wfs rlog myc:wfs/cgi/config-intern.pl

3. Installationen aus dem .tgz File:

Laden Sie das .tgz Archiv auf Ihren Server.

Entpacken Sie das Archiv. Sie erhalten ein Verzeichnis wfs/.

Verschiebene Sie das Verzeichnis z.B. nach /usr/local oder /.

4. Installieren Sie die benötigten Softwarebibliotheken.

Siehe Installation benötigter Software Bibliotheken.

http://www.mycontrol.de/workflow/

http://www.mycontrol.de/workflow/


16

5. Legen Sie eine neue Datenbank mit dem Namen wfs im MySQL Server an.

(Kommandozeile: mysqladmin create wfs oder phpMyAdmin benutzen.)

6. WFS konfigurieren

a. Kopieren Sie im Verzeichnis cgi/ die Datei config.pl.dist nach config.pl.

b. Passen Sie die config.pl Datei an.

7. Geben Sie dem Webserver Leseberechtigung für alle wfs-Dateien und Schreibberechtigung für dieVerzeichnisse data/temp und data/documents.

Linux/FreeBSD Wenn Ihr Webserver z.B. als Benutzer www läuft, lautet derBefehl hierfür chown www data/temp data/documents.

Windows (IIS, experimentell) Im IIS setzen Sie die Schreibrechte für die Gruppen "IIS_USRS"und "Benutzer". Stellen Sie sicher, dass der WebserverLesezugriff auf alle anderen Dateien des Workflow erversbesitzt.

8. Richten Sie die Webserver-Konfiguration ein.

Linux/FreeBSD (Apache) Eine Vorlage für die notwendige Apache-Konfiguration findenSie in data/install/apache-config.txt.

Windows (IIS, experimentell) Setzten Sie den Physikalischen Pfad aus das www/ Verzeichnisin der WFS Working Copy und richten Sie ein virtuellesVerzeichnis namens cgi ein, das auf das Verzeichnis cgi/zeigt mit einem CGI Handler für Dateien mit dem Namen *.cgiund dem Executable C:\Perl\bin\perl.exe "%s" %s underteilen für genau diesen String eine ISAPI- und CGI-Zulassung.

9. Datenbank initialisieren

a. Wechseln Sie in das Verzeichnis data/db-struct/ der Workflow-Server Installation.

b. Führen Sie folgenden Befehl aus. Das System erzeugt dann die notwendigen Datenstrukturenund liest die Default-Daten ein:

./datastructure-diff install

c. Falls bei dieser Aktion Fehlermeldungen angezeigt werden prüfen Sie bitte Benutzername undPasswort des DB_USERs in der config.pl.

10. Testen Sie Ihre Installation, indem Sie in Ihrem Browser zu folgender URL navigieren:http://wfs.domain.de/cgi/checkinstall.cgi

(Ersetzen Sie hierbei Rechnernamen und Pfad durch Ihre Angaben.)

Das Skript prüft die Systemumgebung und weist Sie auf evtl. Fehler hin.

11. Loggen Sie sich in Ihren Workflow Server ein. Die Zugangsdaten für den Administrationszugangdirekt nach der Installation lauten:

Benutzername admin

Passwort start

Sie sollten aus Sicherheitsgründen Ihr Administratorpasswort direkt nach dem Login ändern. Umden vollen Funktionsumfang Ihre MyControl Workflowservers nutzen zu können fahren Sie fort mitAnhang C, Installationsanleitung, Teil II.


17

C. Installationsanleitung, Teil IIFolgende Installationsschritte sind notwendig, wenn Sie Ihren MyControl Workflow Server in vollemUmfang nutzen wollen. Diese Schritte können jederzeit nachgeholt werden.

1. Anlegen von Datenbank-Berechtigungen

Warnung

Wir empfehlen Ihnen dringend Ihren WFS nicht mit dem MySQL-User root zubetreiben sondern zwei spezielle MySQL-User mit streng eingeschränkten Rechteneinzurichten.

Erstellen Sie zwei Benutzer (z.B. wfs und wfs_script) und weisen Sie diesen Passwörter unddie folgenden Berechtigungen zu:

a. Benutzer wfs (DB_USER) Dieser Benuzer wird vom Workflow Server selbst verwenden.Gewähren Sie SELECT-, INSERT-, UPDATE-, DELETE-,CREATE-, ALTER- und DROP-Rechte auf die gesamteDatenbank (alle Tabellen).

b. Benutzer wfs_script(SCRIPT_DB_USER)

wfScript besitzt einen Zugriff auf die Datenbank, dermit diesem Benutzernamen durchgeführt wird. Je nachinstallierten wfScript-Programmen benötigen Sie hierandere Berechtigungen. Üblicherweise gewähren SieSELECT-Rechte auf alle Tabellen.

Anmerkung

Die MySQL-Berechtigungen für denwfs_script-Benutzer können Sie zur Erhöhungder Sicherheit weiter einschränken undnur Berechtigungen auf Tabellen vergeben,auf welche die Skripte mittels $db-Objektzugreifen müssen.

Tragen Sie Benutzernamen und Passwört in die config.pl ein.

2. Richten Sie einen Cronjob für die E-Mail-Benachrichtigung ein.

Wählen Sie einen User mit ausreichenden Berechtigungen um die Programm- undKonfigurationsdateien zu lesen. Hier bieten sich die User "www" oder "root" an oder der gleicheUser wie beim nächsten Punkt.

Wenn Ihre Installation im Verzeichnis /wfs liegt und alle 5 Minuten auf Benachrichtigungen geprüftwerden soll, tragen Sie die folgende Zeile in Ihre crontab ein:

*/5 * * * * cd /wfs/bin/; ./wfs-reminder.pl

3. Richten Sie einen Cronjob für das automatische Einspielen von wichtigen Patches ein:

Dieser Cronjob muß für den User eingetragen werden, der den cvs login und checkout ausgeführthat, so daß ausreichende Berechtigungen vorhanden und der cvs Zugang ohne Passworteingabemöglich sind.

Dieser Mechanismus ist nur für Release-Installationen zu empfehlen, dort aber wichtig.

In Release-Branches werden nur wichtige und dringende Patches und Sicherheits-Updatescommitet.


18

Dieser cronjob muß nicht eingerichtet werden, in dieser Dokumentation wird allerdings davonausgegangen, daß regelmäßige cvs updates erfolgen.

Dieser cronjob wird die Installation nicht automatisch auf eine neue WFS Version upgraden.

Beispielzeile:

30 4 * * * cd /wfs; cvs -Q up -dP

D. betriebssystemabhängigeInstallationsanleitungenCVS Installation Sollte Ihr System kein CVS installiert haben, so können Sie dies wie

folgt installieren:

Debian apt-get install cvs

Ubuntu apt-get install cvs

Fedora yum install cvs

Windows (experimentell) Installieren Sie TortoiseCVS(http://www.tortoisecvs.org)

Installation benötigter SoftwareBibliotheken

FreeBSD In data/install/needed-ports.txt finden Sie eine Listeder zu installierenden Ports.Diese können mittels cd /usr/ports/portname; makeinstall clean installiertwerden.

Debian In /data/install/needed-packages-debian.txt findenSie eine Liste der zuinstallierenden Packages. Diesekönnen mittels apt-getinstall paketname installiertwerden. Zur Installation vonApache FOP müssen Sie ggf. in/etc/apt/sources.list dascontrib Repository hinzufügenund apt-get update aufrufen.

Ubuntu In /data/install/needed-packages-ubuntu.txt findenSie eine Liste der zuinstallierenden Packages. Diesekönnen mittels apt-getinstall paketname installiertwerden.

openSUSE In /data/install/needed-packages-opensuse.txtfinden Sie eine Liste der zuinstallierenden Packages. Diese

http://www.tortoisecvs.org


19

können mittels zypper installpaketname installiert werden.Das Modul Safe::Hole müssenSie per CPAN installieren: perl -e 'install Safe::Hole' -MCPAN

Fedora In /data/install/needed-packages-fedora.txt findenSie eine Liste der zuinstallierenden Packages. Diesekönnen mittels yum installpaketname installiert werden.Das Modul Safe::Hole müssenSie per CPAN installieren:

1. yum install gcc perl-CPAN perl-Module-Build

2. perl -e 'installSafe::Hole' -MCPAN

Windows (experimentell) Mit dem Programm ppm allefehlenden Pakete installieren.Welche Pakete in ihrer Installationfehlen entnehmen Sie denFehlermeldungen des IIS. DieserSchritt muß ggf. mehrmals, auchzu einem späteren Zeitpunkt,wiederholt werden.

E. Installationsanleitung Fax-GatewaySipgate1. Zur Nutzung des Fax-Gateways benötigen Sie einen Vertrag und die Zugangsdaten des VoIP-

Anbieters "Sipgate".

2. Kopieren Sie im Verzeichnis bin die Datei faxgw-sipgate.pl.DIST nach faxgw-sipgate.pl

3. Geben Sie der Datei Berechtigung zur Ausführung (chmod +x faxgw-sipgate.pl)

4. Editieren Sie die Datei faxgw-sipgate.pl und tragen Sie die folgendenInformationen ein:

USER Benutzername im Workflow Server. Dieser Benutzer benötigt Berechtigung fürSOAP.

PASS Passwort des WFS-Benutzers

SIPGATE_USER Ihr Benutzername bei Sipgate

SIPGATE_PASS Ihr Passwort bei Sipgate


20

5. Tragen sie einen Cronjob für das Skript ein, so dass dieses regelmässig aufgerufen wird.

F. Springloops SVN post-commit HooksDer webbasierte Springloops SVN-Server erlaubt es, nach erfolgtem Commit ein Skript auf einementfernten Host per HTTP / HTTPS aufzurufen. Der WFS bietet dazu das Skript svn-loginfo.cgi,was zu jedem Commit, bei dem die Bemerkung mit einer Tasknummer beginnt, eine interne Bemerkungin den passenden Task schreibt. svn-loginfo.cgi wird folgendermaßen eingerichtet:

1. Tragen Sie in config.pl, in der Variable $CONF{'SPRINGLOOPS_SERVERS'}, die Hostnamenaller Springloops Server, von denen ein post-commit Hook angenommen werden soll, sowie diedazugehörigen Webserver, auf den der Changeset-Link in der internen Bemerkung verlinken soll,ein. (Siehe Beispiel in config.pl.dist)

2. Tragen Sie optional in config.pl, in der Variable $CONF{'SPRINGLOOPS_NEEDED_RIGHT'}ein Recht ein, welches vor dem Eintragen einer internen Bemerkung zusätzlich zu denProjektrechten geprüft wird. Dieses Recht muss auch im WFS Administrator-Interface definiert undden gewünschten Benutzern zugeordnet werden.

3. Der oder die Benutzer, die das Feature nutzen wollen, müßen im Springloops Webinterface in ihrenAccount-Daten ihren WFS-Benutzernamen als 'First name' eintragen. 'Last name' kann beliebiggewählt werden. Der von Springloops übertragene Autor-Name wird zur Rechteprüfung im WFSverwendet, daher muß 'First name' einem WFS Benutzernamen entsprechen, der Schreibzugriffauf die gewünschten Projekte hat.

4. Tragen Sie auf der Springloops SVN Website, unter den Projektoptionen, die URL zu Ihrem WFSin das Feld 'Post commit notification' ein: http://wfs.domain.de/cgi/svn-loginfo.cgi

5. Committen Sie nun ein File in ihrem SVN Repository, und geben Sie in der ersten Kommentarzeileeine (im ihrem WFS vorhandene) Task-Nummer an. In diesem Task erscheint eine neue interneBemerkung mit einem Link zum Changeset sowie Name und Email-Addresse des Autors.

svn-loginfo.cgi funktioniert nur mit einem webbasierten Springloops-Server, nicht mit einemkonventionellen SVN Server.

G. Upgrade auf eine neue WFS VersionDen Status und cvs tag (RELxxx) der nächsten WFS Version erfahren Sie im WFS unter Admin >Update oder Sie informieren sich über die aktuellen Entwicklungen auf unserer facebook Seite.

Ihr WFS sollte einen automatischen CVS update, mindestens einmal täglich, durchführen. Falls dasnicht der Fall ist müßen vor einem Upgrade den cvs update von Hand durchführen.

Sobald die nächste WFS Version den Release Status erreicht hat sollten Sie ihren WFS upgraden.

Sicherheitsupdates werden nur für den aktuellen Release und die Entwicklungsversion (HEAD)bereitgestellt.

Gehen Sie dazu wie folgt vor:

1. wechseln Sie in ihr WFS Installations-Verzeichnis [cd /wfs]

2. cd data/update

3. ./update.pl

Wenn kein update.pl im Verzeichnis data/update/ liegt, dann ist noch keine neue WFS Versionverfügbar. Sobald die Datei vorhanden ist können und sollen Sie Ihren WFS upgraden.


21

Das Update ist normal ohne Ausfallzeit durchführbar und dauert nur wenige Minuten.

Sicherheitshalber sollten Sie bei kritischen Installationen dennoch in kurzes Wartungsintervallankündigen.

Der Update Prozess wird sich mit steigender Anzahl von unterschiedlichen Installation ändern. LesenSie deswegen vor einem Update bitte nochmal an dieser Stelle nach, ob noch alles beim Alten ist.

Administrationshandbuch - MyControl® Workflow...

Documents

Transcript of Administrationshandbuch - MyControl® Workflow...